Welcome to Hermine’s documentation

Warning

As the application itself, this documentation is very much a work in progress.

The documentation is created with Sphinx, and written (mostly) in Markdown, thanks to MyST. The MyST documentation will guide you through the sphinx-specific directives in Markdown. Some options like code fences using colors and field lists have been activated.

You will find the source of this documentation in the docs/source folder of the repo.

To build it locally, you must first install the application locally and configure it as explained in the installation page. Dont’t forget to activate your poetry env with :

poetry shell

and then actually build the html pages:

sphinx-build -b html docs/source docs/build/html 

Once it’s build, you can visualize the pages in your browser using Python’s web server module:

python -m http.server --directory docs/build/html

This documentation is published under the CC-BY-4.0 license.

Contents

• Using Hermine
  • Installing Hermine for production
  • Getting started
  • Defining a FOSS policy
  • Reference data
  • REST API
• Developing Hermine
  • Basic development workflow
  • Coding standards
  • The Data Model
  • Permissions
  • Custom tags for Django templates
  • Tests
  • Monitoring performances

Indices and tables

• Index

• Module Index