Skip to main content

Automatic documentation pages generation

Project description

Documentation Status PyPI Build Status GitHub

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:

  • 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 gendocs


Want to easily create a new project that will build its own documentation? Try the gendocs Cookiecutter which will prompt you for your new project’s details and create all the needed file structures for your new, automatically documented Python package.

To create a new project, make sure you have Cookiecutter installed in your virtual environment:

$ pip install cookiecutter

Now you can use our Cookiecutter template to create a new project ready for gendocs by executing the following command and following the prompts:

$ cookiecutter

That’s it! Now you have a new Python project ready for automatic documentation and deployment.


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 then add the following somewhere near the top of your

# Import the package to document:
import wonderfulpackage

# Automatically generate documentation pages
from gendocs import Generator

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](](

RST / Sphinx:

.. image::
   :alt: Documentation Built by gendocs


Check out gendocs of GitHub to Contribute and make automatic documentation even better!

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gendocs-0.4.0.tar.gz (8.1 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page