# sectiondoc

**Repository Path**: mirrors_enthought/sectiondoc

## Basic Information

- **Project Name**: sectiondoc
- **Description**: Default Repo description from terraform module
- **Primary Language**: Unknown
- **License**: BSD-3-Clause
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-08
- **Last Updated**: 2025-10-04

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## 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',
        ...,
    ]