Skip to main content

UNKNOWN

Project description

[![Build Status](https://travis-ci.org/enthought/refactordoc.svg?branch=master)](https://travis-ci.org/enthought/refactordoc) [![Coverage Status](https://img.shields.io/coveralls/enthought/refactordoc.svg)](https://coveralls.io/r/enthought/refactordoc?branch=master)

The RefactorDoc extension parses the function and class docstrings as they are retrieved by the autodoc extension and refactors 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.

Key aims of RefactorDoc are:

  • Do not change the order of sections.

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

  • Easier to debug (native support for debugging) and extend (future versions).

Repository

The RefactorDoc extension lives at Github. You can clone the repository using:

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

Installation

  1. Install refactordoc from pypi using pip:

    $ pip install reafactordoc
  2. Add refactor-doc to the extensions variable of your sphinx conf.py:

    extensions = [
        ...,
        'refactordoc',
        ...,
    ]

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

refactordoc-0.3.1.tar.gz (11.3 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page