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


Release history Release notifications

This version
History Node

0.3.1

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
refactordoc-0.3.1.tar.gz (11.3 kB) Copy SHA256 hash SHA256 Source None May 23, 2014

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page