Tristan Nolde 98a189b94c
docs: Abschlussarbeit on data ingestion (#500)
Co-authored-by: Philipp Horstenkamp <philipp@horstenkamp.de>
2024-01-02 15:50:58 +01:00

84 lines
2.0 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.
.. On the 9th September 2023 the following current development state has been determined:
.. .. drawio-figure:: project_management/Arch.-Planning.drawio
:format: png
:page-index: 1
.. The target deployment architecture should look as follows:
.. .. drawio-figure:: project_management/Arch.-Planning.drawio
:format: png
:page-index: 2
.. The timeline to reach this goal is:
.. .. drawio-figure:: project_management/Arch.-Planning.drawio
:format: png
:page-index: 3
.. An example diagram
.. 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`