https://github.com/enthought/sectiondoc

Default Repo description from terraform module
https://github.com/enthought/sectiondoc

Last synced: 8 months ago
JSON representation

Default Repo description from terraform module

• Host: GitHub
• URL: https://github.com/enthought/sectiondoc
• Owner: enthought
• License: other
• Created: 2012-02-07T00:05:48.000Z (over 14 years ago)
• Default Branch: master
• Last Pushed: 2019-09-06T13:08:26.000Z (almost 7 years ago)
• Last Synced: 2024-12-27T02:42:25.903Z (over 1 year ago)
• Language: Python
• Homepage:
• Size: 269 KB
• Stars: 0
• Watchers: 21
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.txt
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
Sectiondoc: Docstring section rendering sphinx extension

========================================================

.. image:: https://travis-ci.org/enthought/sectiondoc.svg?branch=master

   :target: https://travis-ci.org/enthought/sectiondoc

   :alt: Build status

.. image:: http://codecov.io/github/enthought/sectiondoc/coverage.svg?branch=master

   :target: http://codecov.io/github/enthought/sectiondoc?branch=master

   :alt: Coverage status

.. image:: https://readthedocs.org/projects/sectiondoc/badge/?version=latest

   :target: http://sectiondoc.readthedocs.org/en/latest/?badge=latest

   :alt: Documentation Status

The sectiondoc extension parses the function and class docstrings as

they are retrieved by the autodoc extension and renders the section

blocks into sphinx friendly rst. The extension shares similarities

with alternatives (such as numpydoc) but aims at reflecting the

original form of the docstring and support project specific

customizations.

Key features of **sectiondoc** are:

    - Do not change the order of sections.

    - Allow sphinx directives between (and inside) section blocks.

    - Custom rendering styles

.. note::

       Sectiondoc should work with sphinx >= 0.4 that provides

       the ``autodoc-process-docstring`` hook.

Repository

----------

The sectiondoc extension lives at Github. You can clone the repository

using::

    $ git clone https://github.com/enthought/sectiondoc.git

Installation

------------

Install ``sectiondoc`` from pypi using pip::

    $ pip install sectiondoc

Install the latest developing version using::

    $ pip install git+https://github.com/enthought/sectiondoc.git#egg=sectiondoc

Usage

-----

Styles can be selected by referencing in ``conf.py`` the module they are defined::

    extensions = [

        ...,

        'sectiondoc.styles.legacy',

        ...,

    ]