Pysphinxdoc is a tool for generating automatically API documentation for Python modules, based on their reStructuredText docstrings, using the sikit-learn theme, Bootstrap and Sphinx. Visit this module documentation for a live example.
Here is an exemple to generate the ‘pysphinxdoc’ module documentation: first execute ‘sphinxdoc -v 2 -p $HOME/git/pysphinxdoc/ -n pysphinxdoc -o $HOME/git/pysphinxdoc/doc/’ and then in the $HOME/git/pysphinxdoc/doc/ folder ‘make raw-html’.
Expect a ‘$name_module/doc/source/_static’ folder containing a logo named ‘$name_module.png’ and an ‘carousel’ subfolder containing a list of images to be displayed in the index banner of the site.
The documentation is generated from the reStructuredText docstrings of each module, function or class.
In order to find module information, an ‘info.py’ module is expected at the root of the module with mandatory keys:
NAME: the name of the module.
DESCRIPTION: the module short description that will be displayed in the banner.
LONG_DESCRIPTION: the index page content.
URL: the module URL.
AUTHOR: the author of the module.
AUTHOR_EMAIL: the author e-mail.
__version__: the module version.
And optional keys:
EXTRANAME: a name that will be displayed in the last element of the navbar (default ‘PYSPHINXDOC’).
EXTRAURL: the associated URL (default the pySphinxDoc URL).
1 maintainer
Metadata
1 maintainer
Release files for pysphinxdoc 1.0.0
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 | Actions |
|---|---|---|---|---|
| pysphinxdoc-1.0.0.tar.gz | 301.2 kB | Without provenance | Details for pysphinxdoc-1.0.0.tar.gz |
Release files / pysphinxdoc-1.0.0.tar.gz
| Download URL | pysphinxdoc-1.0.0.tar.gz |
|---|---|
| Size | 301.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d4d15343222697c3436c0f63aa193fe2da41d0fd9c1501e7ff3ab9c164e5c327
|
|
BLAKE2b-256 checksum How to use checksums |
e872f06f51c72758fad8791dd567cd0970d74fd7263b3fcfabacf80206eeee6f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for pysphinxdoc 1.0.0
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.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
