Repository Setup

Overview

The docs-hub relies on the project repositories to provide and build their own documentation. The projects and docs-hub uses a static web page documentation branch, inspired by the Github Pages.

Project Documentations

Each project can use any combination of tools for documentation generation. The only requirement is that the generated documentation should be a static website. This allows different kind of projects to use the documentation tool that fits the project tooling ecosystem.

The documentation must be pushed into a branch for keeping the documentation. Whether the documentation is versioned or rewritten on every document generation is up to the maintainers.

Docs Hub Submodules

The documentation branch of the projects are used as submodules for the main branch. The static documentations are organized by docs-hub using MkDocs. The MkDocs configurations are edited based on how the projects must be grouped together.

When MkDocs builds the documentation, the static documentation from the different projects are added to the build automatically, creating a stand-alone web page for all the documentation.