Documentation

The project’s technical documentation helps interested parties, users and developers to understand the project, registering fundamental information and describing in more depth how Querido Diário works and what features it offers.

All official documentation (this site!) is generated from the repository’s .rst files, built with the Sphinx documentation generator, using the sphinx-rtd-theme, and is hosted on the Read The Docs service.

Each of the pages on this site, listed in the navigation menu, corresponds to a file of the same name in the /docs directory. You can also access the files via the “Edit on GitHub” link at the top of every page.

Important

It is important that the documentation is up-to-date and relevant to the community. Don’t hesitate to contribute with pull requests (PRs) for adjustments, complements and additions, as well as translations into other languages.