steenzout.sphinx package

Module contents

Package to standardize Sphinx documentation in a GitHub organization.

class ResourceGenerator(organization, package)[source]

Bases: object

Class to generate Sphinx resources.

Parameters:
  • organization (str) – name of the profile of the organization on GitHub.
  • package (str) – package to be documented.
  • metadata (Python module) – module containing the package metadata.
  • env (jinja2.Environment) – the Jinja2 environment.
conf()[source]

Generate the Sphinx conf.py configuration file

Returns:the contents of the conf.py file.
Return type:(str)
makefile()[source]

Generate the documentation Makefile.

Returns:the contents of the Makefile.
Return type:(str)