Start

Welcome to the Docs-As-Code Demo

This is a demonstration repo to show the usage of the docs-as-code methodology. It incorporates the following tooling:

Sphinx is the documentation generator that is used to build the documentation.

Sphinx-Needs adds requirements to Sphinx.

The html theme you’re just looking at.

A sphinx extension that allows writing docs with Markdown- in addition to restructuredText-Syntax (Sphinx default).

The defacto standard C++ API documentation tool

A tool we co-developed to integrate Doxygen documentations into Sphinx-Documentation.

Last but not least Python, in which Sphinx was developed.

Note

This repo contains some example data loosely related to the “automotive domain”. None, some or all parts may have been generated by AI tools 😃. The data may not make any sense, however we still think it’s better than having “lorem ipsum” text. If you find any of the data offensive or just too stupid, please contact us and we’ll remove it.