RefactorDoc: Docstring refactor sphinx extension

[![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

Install refactordoc from pypi using pip:
```
$ pip install reafactordoc
```
Add refactor-doc to the extensions variable of your sphinx conf.py:
```
extensions = [
    ...,
    'refactordoc',
    ...,
]
```

Metadata

Release files for refactordoc 0.3.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for refactordoc 0.3.1
File	Size	Uploaded	Provenance	Actions
refactordoc-0.3.1.tar.gz	11.3 kB	May 23, 2014	Without provenance	Details for refactordoc-0.3.1.tar.gz

Release files / refactordoc-0.3.1.tar.gz

Download URL	refactordoc-0.3.1.tar.gz
Size	11.3 kB
Tags	Source
SHA-256 checksum How to use checksums	`64f23ae44f347cf3c03cd24267a5aced547d34fae395f0dcc192d2ef56626df7`
BLAKE2b-256 checksum How to use checksums	`5f0ef19527a334a03b73fea7af787d91b88d84bf69f49db807f75595c29dcdb4`
Upload date	May 23, 2014
Uploaded using Trusted Publishing? What is trusted publishing?	No

Security for refactordoc 0.3.1

Report project as malware

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.3.1 This release

May 23, 2014 1 release file No provenance

refactordoc 0.3.1