Automatic documentation pages generation
Project description
This is a Python package for automatically building the documentation pages to document a given Python package using Sphinx. gendocs allows users to keep all of their documentation directly within their packages as pages are generated directly from the docstrings in the code!
Connections
Want to see examples? Check out one of the following projects which uses gendocs:
PVGeo: A Python package for visualizing geophysical data in VTK and ParaView
ESPA Tools: A Python package for simple loading of Landsat imagery as NumPy arrays
Get Started
Install gendocs from PyPI:
$ pip install gendocsUsage
This generator is built for Sphinx (RST) documentation. To document your package, setup sphinx and a conf.py then add the following somewhere near the top of your conf.py:
# Import the package to document:
import wonderfulpackage
# Automatically generate documentation pages
from gendocs import Generator
Generator().DocumentPackages(wonderfulpackage)That’s it! That code block above is all you need to do to fully document your package(s). Now you can build the Sphinx documentation and all docs pages will be automatically generated.
Let People Know
If your project generates documentation automatically, please add a badge to your project to let people know! We hope that these badges will stir curiosity, involvement, and community contributions to the gendocs package.
Markdown:
[](https://gendocs.readthedocs.io/en/latest/)RST / Sphinx:
.. image:: https://img.shields.io/badge/docs%20by-gendocs-blue.svg
:target: https://gendocs.readthedocs.io/en/latest/
:alt: Documentation Built by gendocsContribute
Check out gendocs of GitHub to Contribute and make automatic documentation even better!
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 gendocs-0.3.0.tar.gz.
File metadata
- Download URL: gendocs-0.3.0.tar.gz
- Upload date:
- Size: 7.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.0.0 requests-toolbelt/0.8.0 tqdm/4.24.0 CPython/2.7.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 4ac3d53f65a4a39d4a5a8bd59a28745b8965f5ab6be4c9f38982e2cf50a6a290 |
|
| MD5 | 0ad64d84a08143a5bbf9647e21c8eddd |
|
| BLAKE2b-256 | 24df127aef11378b789a4a2a50ee42b0123f7cd68f1c5350ed30975838fd64af |
