Automatic documentation pages generation
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!
Want to see examples? Check out one of the following projects which use gendocs:
Install gendocs from PyPI:
$ pip install gendocs
Already have a Python package in need of automatic documentation? Follow these steps.
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 document your package(s) thoroughly. 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.
[![Documentation Built by gendocs](https://img.shields.io/badge/docs%20by-gendocs-blue.svg)](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 gendocs
Check out gendocs of GitHub to Contribute and make automatic documentation even better!
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.