mirror of
https://github.com/fhswf/aki_prj23_transparenzregister.git
synced 2025-06-22 05:23:54 +02:00
Refactored the index.rst (#497)
Reworked the index.rst as requested in our meeting. Made drawio background transparent. Minor tweaks. --------- Co-authored-by: Tristan Nolde <tristan.nolde@yahoo.de>
This commit is contained in:
@ -1,75 +1,71 @@
|
||||
.. Your Package Name documentation master file, created by Sphinx
|
||||
|
||||
Transparenzregister Dokumentation
|
||||
=================================
|
||||
This is the documentation for the AKI project group on the german transparenzregister and an Analysis there of.
|
||||
|
||||
On the 9th September 2023 the following current development state has been determined:
|
||||
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.
|
||||
|
||||
.. drawio-figure:: project_management/Arch.-Planning.drawio
|
||||
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:
|
||||
.. The target deployment architecture should look as follows:
|
||||
|
||||
.. drawio-figure:: project_management/Arch.-Planning.drawio
|
||||
.. .. drawio-figure:: project_management/Arch.-Planning.drawio
|
||||
:format: png
|
||||
:page-index: 2
|
||||
|
||||
The timeline to reach this goal is:
|
||||
.. The timeline to reach this goal is:
|
||||
|
||||
.. drawio-figure:: project_management/Arch.-Planning.drawio
|
||||
.. .. drawio-figure:: project_management/Arch.-Planning.drawio
|
||||
:format: png
|
||||
:page-index: 3
|
||||
|
||||
An example diagram
|
||||
.. An example diagram
|
||||
|
||||
.. include:: ../README.md
|
||||
:parser: myst_parser.sphinx_
|
||||
.. include:: ../CONTRIBUTING.md
|
||||
:parser: myst_parser.sphinx_
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 3
|
||||
:caption: Project Management
|
||||
|
||||
project_management/*
|
||||
|
||||
.. toctree::
|
||||
:glob:
|
||||
:maxdepth: 1
|
||||
:caption: Meeting Notes:
|
||||
|
||||
meeting-notes/*
|
||||
|
||||
.. toctree::
|
||||
:glob:
|
||||
:maxdepth: 3
|
||||
:caption: Research
|
||||
|
||||
research/*
|
||||
|
||||
.. toctree::
|
||||
:glob:
|
||||
:maxdepth: 3
|
||||
:caption: Seminararbeiten
|
||||
:numbered:
|
||||
|
||||
seminararbeiten/DevOps/Seminarpraesentation.ipynb
|
||||
seminararbeiten/Datenspeicherung/00_Datenspeicherung
|
||||
Ergebnisse/Abschlussbericht_und_Praesentation/PhHo/05-DEV-OPS
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 3
|
||||
:caption: Abschlussberichte
|
||||
:numbered:
|
||||
|
||||
Ergebnisse/Abschlussbericht_und_Praesentation/PhHo/05-DEV-OPS
|
||||
|
||||
.. .. toctree::
|
||||
:glob:
|
||||
:maxdepth: 1
|
||||
:caption: UI Mock Ups
|
||||
|
||||
mock_up/**/*
|
||||
.. mock_up/**/*
|
||||
|
||||
.. toctree::
|
||||
:glob:
|
||||
:maxdepth: 1
|
||||
:caption: Meeting Protokolle
|
||||
|
||||
meeting-notes/*
|
||||
|
||||
.. toctree::
|
||||
:glob:
|
||||
:maxdepth: 6
|
||||
:caption: Modules
|
||||
:caption: API
|
||||
|
||||
modules
|
||||
|
||||
@ -80,6 +76,8 @@ The timeline to reach this goal is:
|
||||
:inherited-members:
|
||||
:autodoc_member_order:
|
||||
|
||||
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
* :ref:`genindex`
|
||||
|
Reference in New Issue
Block a user