:hidden:
:maxdepth: 1
:caption: Requirements
docs/stakeholder_requirements
docs/software_requirements
docs/software_components
docs/external_requirements
:hidden:
:maxdepth: 1
:caption: Visualizations
docs/needflow
docs/needtable
:hidden:
:maxdepth: 1
:caption: Software Design
docs/doxygen/demo/html/index
:hidden:
:maxdepth: 1
:caption: Usage
docs/getting_started.md
This is a demonstration repo to show the usage of the docs-as-code methodology. It incorporates the following tooling:
(cards-clickable)=
::::: {grid} 3 :gutter: 2
:link: https://www.sphinx-doc.org/
:img-top: docs/images/sphinx.png
Sphinx is the documentation generator that is used to build the documentation.
:link: https://sphinx-needs.readthedocs.io/en/latest/
:img-top: docs/images/sphinxneeds.png
Sphinx-Needs adds requirements to Sphinx.
:link: https://sphinx-book-theme.readthedocs.io/
:img-top: docs/images/booktheme.png
The html theme you're just looking at.
:link: https://myst-parser.readthedocs.io/
:img-top: docs/images/myst.png
A sphinx extension that allows writing docs with Markdown- in addition to restructuredText-Syntax (Sphinx default).
:link: https://www.doxygen.nl/
:img-top: docs/images/doxygen.png
The defacto standard C++ API documentation tool
:link: https://boschglobal.github.io/doxysphinx/
:img-top: docs/images/doxysphinx.png
A tool we co-developed to integrate Doxygen documentations into Sphinx-Documentation.
:link: https://www.python.org/
:img-top: docs/images/python.png
Last but not least Python, in which Sphinx was developed.
:::::
:name: a note on the example data
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.