Tristan Nolde e30f6b813d
docs/document-structure (#578)
Habe per toctree die verschiedenen Dokumente in die richtige Reihenfolge
gebracht.

---------

Co-authored-by: Tim Ronneburg <Tim-Ronneburg@users.noreply.github.com>
Co-authored-by: Sebastian <94404394+SeZett@users.noreply.github.com>
Co-authored-by: Philipp Horstenkamp <philipp@horstenkamp.de>
Co-authored-by: SeZett <zeleny.sebastian@fh-swf.de>
2024-01-25 17:49:23 +01:00

53 lines
1.2 KiB
ReStructuredText

Transparenzregister Dokumentation
=================================
Dies ist die Dokumentation der AKI Projektgruppe über ein Transparenzregister deutscher Firmen und deren Interaktionen.
Das Projekt startete im Sommersemester 2023 und dauerte ein Jahr.
Die Dokumentation ist zwar auf Deutsch, wir steigen aber ein mit der `README.md` und der `CONRIBUTING.md`.
Diese sind, um Industriestandards zu entsprechen, auf Englisch gehalten.
.. include:: ../README.md
:parser: myst_parser.sphinx_
.. include:: ../CONTRIBUTING.md
:parser: myst_parser.sphinx_
.. toctree::
:maxdepth: 5
:caption: Projektdokumentation
:numbered:
Ergebnisse/1_Einleitung.md
Ergebnisse/2_Recherche.md
Ergebnisse/3_Grundlagen.md
Ergebnisse/4_Umsetzung.md
Ergebnisse/Abschlussbericht_und_Praesentation/SeZe/S5-1.md
.. toctree::
:glob:
:maxdepth: 1
:caption: Meeting Protokolle
meeting-notes/*
.. toctree::
:glob:
:maxdepth: 6
:caption: API
modules
.. automodule:: aki_prj23_transparenzregister
:members:
:undoc-members:
:show-inheritance:
:inherited-members:
:autodoc_member_order:
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`