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
Metadata
1 maintainer
Release files for sphinx-refdoc 0.3.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| sphinx-refdoc-0.3.1.tar.gz | 8.2 kB | Without provenance | Details |
Release files / sphinx-refdoc-0.3.1.tar.gz
| Download URL | sphinx-refdoc-0.3.1.tar.gz |
|---|---|
| Size | 8.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4f629412ae4f95c8074da77c6666370c61e29a4c19f168febe4ab6b0ba66edb1
|
|
BLAKE2b-256 checksum How to use checksums |
4a6bfefe7e05fdd7771b73f0acf2bad923272aeb3d8b1a2445119ea5fbe0bde3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
Python-urllib/3.6
|
Security for sphinx-refdoc 0.3.1
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.
