Philipp Horstenkamp f645e2ec4b
Added a section on startup in the README.md (#507)
Reworked the index.md
- removed commented out text

Minor restructuring of the README.md

---------

Co-authored-by: Tristan Nolde <tristan.nolde@yahoo.de>
2024-01-03 18:31:01 +01:00

64 lines
1.5 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: 3
:caption: Seminararbeiten
:numbered:
Ergebnisse/Zwischenbericht_und_Praesentation/PhHo/dev-ops
Ergebnisse/Zwischenbericht_und_Praesentation/TrNo/Ausarbeitung.md
seminararbeiten/Datenspeicherung/00_Datenspeicherung
.. toctree::
:maxdepth: 3
:caption: Abschlussberichte
:numbered:
Ergebnisse/Abschlussbericht_und_Praesentation/PhHo/05-DEV-OPS
Ergebnisse/Abschlussbericht_und_Praesentation/TrNo/S4-2.md
Ergebnisse/Abschlussbericht_und_Praesentation/TrNo/S4-3-1.md
Ergebnisse/Abschlussbericht_und_Praesentation/PhHo/4-4-2-database-generator
.. 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`