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, install the dev dependencies of the project and use the command:

sphinx-build -b html docs/source docs/build/html
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
  • Working with DevContainer
  • Specific aspects

Indices and tables

• Index

• Module Index