Documentation

The best thing you can do for future self is to write both tests and documentation about your project. This section explains how to structure and organize documentation in your project.

Structure

We use the next structure:

  • pages/ - the directory for all *.rst files about the boilerplate.
  • project/ - this directory is for *.rst files associated with your project (this can include auto-generated docs, business logic, etc.)

All new files should be added to index.rst.

Linter

Doc8 is an opinionated style checker for rst styles of documentation. This linter used by default.

Read more: