Reference documentation generator for sphinx
sphinx-refdoc is a python reference documentation generator for Sphinx.
$ pip install sphinx-refdoc
$ sphinx-refdoc -i <src_pkg_1> -i <src_pkg_2> -o <out_dir>
sphinx-refdoc will parse you’re source tree passed as the first parameter. It will then generate a stub for sphinx reference documentation for that source. It auto-generates all required files (one per module) and creates a navigation based on the package structure of the source code.
It then saves it into the directory passed as the second argument. This will usually be a subdirectory of the sphinx documentation directory. You can then easily include the generated docs with you existing documentation by pointing to the <out_dir>/index.rst. Lets say you have a following directory structure:
docs/ ├── ref/ └── index.rst
where docs/ref is the directory containing the generated reference docs (2nd argument of sphinx-refdoc invocation) and index.rst is the documentation main index file (conf.py points to it). Then if you want to include the reference documentation, you just need to add ref/index to the toctree. For example:
.. toctree:: my_topic_1 my_topic_2 docs/ref
Setting up development repo
$ git clone firstname.lastname@example.org:novopl/sphinx-refdoc.git $ cd sphinx-refdoc $ virtualenv env $ source ./env/bin/activate $ pip install -r requirements.txt -r ops/devrequirements.txt
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.