Development docs

How to add documentation

We focus on documentation per project, however it's nice to have a single page to browse to find all docs of all projects. Some parts of documentation like infrastructure diagrams make more sense in a larger context. To make all this as easy as possible to maintain we try to automate our documentation generation. This page will help you to add new projects to the documentation website.

Add new project

Project documentation is automatically collected by our documentation pipeline. All files in the docs directory of your project will be downloaded. A second step will build the Projects overview. It's important for the inclusion that your project's documentation directory has a index.rst file to

You can do this on you local documentation checkout by running.

make download-docs generate-source

Search results