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.

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

Generate the Sphinx configuration file

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

Generate the documentation Makefile.

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