About
sphinx-refdoc is a python reference documentation generator for Sphinx.
Installation
$ pip install sphinx-refdocUsage
$ 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/refContributing
Setting up development repo
$ git clone git@github.com:novopl/sphinx-refdoc.git
$ cd sphinx-refdoc
$ virtualenv env
$ source ./env/bin/activate
$ pip install -r requirements.txt -r ops/devrequirements.txt1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file sphinx-refdoc-0.3.1.tar.gz.
File metadata
- Download URL: sphinx-refdoc-0.3.1.tar.gz
- Upload date:
- Size: 8.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
Python-urllib/3.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4f629412ae4f95c8074da77c6666370c61e29a4c19f168febe4ab6b0ba66edb1
|
|
| MD5 |
ef26af40e989989add49a68ccb7bb258
|
|
| BLAKE2b-256 |
4a6bfefe7e05fdd7771b73f0acf2bad923272aeb3d8b1a2445119ea5fbe0bde3
|
