doc – Documentation

docstring – Docstring manipulation

Docstring manipulation tools

pyhetdex.doc.docstring.format_docstring(*args, **kwarg)

Decorator to allow string formating in docstrings using Format string syntax

Examples

>>> @format_docstring(a=10, b="hi")
... def foo():
...    "I want to say '{b}' {a} times"
...    pass
>>> foo.__doc__
"I want to say 'hi' 10 times"

doc.sphinxext – Custom sphinx extensions

todo – todo directives

Copied from sphinx.ext.todo. The modification has been published on github

Allow todos to be inserted into your documentation. Inclusion of todos can be switched of by a configuration variable. The todolist directive collects all todos of your project and lists them along with a backlink to the original location.

Copyright 2007-2015 by the Sphinx team, see AUTHORS.

BSD, see LICENSE for details.