2. Requirements

2.1. Mandatory

In the python package you want to document, you need to generate the following resources:

  • doc/images: a folder containing images that can be included in the generated web pages.

  • doc/logos: a folder containing different logos - a favicon.ico, a <name>.png, a <name>-desaturate-100.png, a <name>-transparent.png, where <name> refers to your module name.

  • references.bib: a file containing bibtex references.

  • AUTHORS.rst: a list of authors.

  • CHANGELOG.rst: the change log of the project.

2.2. Optional

Optionally, you can add:

  • doc/user_guide/index.rst: a complete user guide.

  • highlights.csv: a table containing one line per highlight. Each line is composed of a reference, thumb location, tooltip, and title.

  • CONTRIBUTING.rst: the contributing guidelines (default guidelines are added).

  • LICENSE.rst: the license (a default license is added).

  • MAINTENANCE.rst: the maintenance guidelines (default guideline are added).