Package mrv :: Package doc :: Module extapi

Module extapi

Functions

api_role(role, rawtext, text, lineno, inliner, options={}, content=[])
Role `:api:` bridges generated API documentation by tool like EpyDoc with Sphinx Python Documentation Generator. source code

setup(app)

source code

Variables

[hide private]

__package__ = 'mrv.doc'

Function Details

[hide private]

api_role(role, rawtext, text, lineno, inliner, options=`{}`, content=`[]`)

source code

Role `:api:` bridges generated API documentation by tool like EpyDoc with Sphinx Python Documentation Generator.

Other tools, other than EpyDoc, can be easily supported as well.

First generate the documentation to be referenced, i.e. with EpyDoc:

   $ mkdir -p doc/_build/html/api
   $ epydoc -o doc/_build/html/api ...

Next step is to generate documentation with Sphinx:

   $ sphinx-build doc doc/_build/html

Module extapi

api_role(role, rawtext, text, lineno, inliner, options={}, content=[])

api_role(role, rawtext, text, lineno, inliner, options=`{}`, content=`[]`)