diff --git a/documentations/index.rst b/documentations/index.rst index 8a9d873..d0d97de 100644 --- a/documentations/index.rst +++ b/documentations/index.rst @@ -1,5 +1,28 @@ -Projektdokumentation Transparenzregister +.. 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: + +.. 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_ @@ -7,12 +30,55 @@ Projektdokumentation Transparenzregister :parser: myst_parser.sphinx_ .. toctree:: - :maxdepth: 1 - :caption: 1. Einleitung + :maxdepth: 3 + :caption: Project Management + + project_management/* .. toctree:: + :glob: + :maxdepth: 1 + :caption: Meeting Notes: + + meeting-notes/* + +.. toctree:: + :glob: :maxdepth: 3 - :caption: 2. Recherche + :caption: Dokumentation + + structure/1-Einleitung.md + structure/2-Recherche.md + structure/3-Grundlagen_und_Basistechniken.md + structure/4-Technische_Realisierung.md +.. toctree:: + :glob: + :maxdepth: 3 + :caption: Research + + research/* + +.. toctree:: + :glob: + :maxdepth: 1 + :caption: UI Mock Ups + + mock_up/**/* + +.. toctree:: + :glob: + :maxdepth: 0 + :caption: Modules + + modules + +.. automodule:: aki_prj23_transparenzregister + :members: + :undoc-members: + :show-inheritance: + :inherited-members: + :autodoc_member_order: + Recent Changes ============== diff --git a/documentations/index_old.rst b/documentations/index_old.rst index 4423893..fe6712b 100644 --- a/documentations/index_old.rst +++ b/documentations/index_old.rst @@ -29,12 +29,6 @@ The timeline to reach this goal is: .. include:: ../CONTRIBUTING.md :parser: myst_parser.sphinx_ -.. toctree:: - :maxdepth: 3 - :caption: 1. Einleitung - - Ergebnisse/Abschlussbericht_und_Praesentation/SaZh/S1-1.md - .. toctree:: :glob: :maxdepth: 1 @@ -77,11 +71,6 @@ The timeline to reach this goal is: :caption: Projektdokumentation - Ergebnisse/Abschlussbericht_und_Praesentation/TiRo/S2-1.md - Ergebnisse/Abschlussbericht_und_Praesentation/PhHo/S4-1.md - Ergebnisse/Abschlussbericht_und_Praesentation/TrNo/S4-2.md - - .. automodule:: aki_prj23_transparenzregister :members: :undoc-members: diff --git a/documentations/structure/1-Einleitung.md b/documentations/structure/1-Einleitung.md new file mode 100644 index 0000000..bbfda17 --- /dev/null +++ b/documentations/structure/1-Einleitung.md @@ -0,0 +1,3 @@ +# 1. Einleitung + +## Projekt-Orga diff --git a/documentations/structure/1-Einleitung.rst b/documentations/structure/1-Einleitung.rst deleted file mode 100644 index 314828f..0000000 --- a/documentations/structure/1-Einleitung.rst +++ /dev/null @@ -1,3 +0,0 @@ -.. toctree:: - :maxdepth: 3 - :caption: 1. Einleitung diff --git a/documentations/structure/2-Recherche.md b/documentations/structure/2-Recherche.md new file mode 100644 index 0000000..f6c9dcd --- /dev/null +++ b/documentations/structure/2-Recherche.md @@ -0,0 +1,3 @@ +# 2. Recherche + +## 2.1.2 Untertest diff --git a/documentations/structure/2-Recherche.rst b/documentations/structure/2-Recherche.rst deleted file mode 100644 index ecf8895..0000000 --- a/documentations/structure/2-Recherche.rst +++ /dev/null @@ -1,3 +0,0 @@ -.. toctree:: - :maxdepth: 3 - :caption: 2. Recherche diff --git a/documentations/structure/3-Grundlagen_und_Basistechniken.md b/documentations/structure/3-Grundlagen_und_Basistechniken.md new file mode 100644 index 0000000..3ff4b5b --- /dev/null +++ b/documentations/structure/3-Grundlagen_und_Basistechniken.md @@ -0,0 +1,10 @@ +# 3. Grundlagen + +## 3.1 Data Mining +## 3.2 Datenspeicherung +[Datenspeicherung](../documentations/seminararbeiten/Datenspeicherung/00_Datenspeicherung.md) +## 3.3 DevOps +[DevOps](../documentations/seminararbeiten/DevOps/Seminarpraesentation.ipynb) +## 3.4 Verflechtungsanalyse +## 3.5 Visualisierung +## 3.6 Sentimentanalyse diff --git a/documentations/structure/3-Grundlagen_und_Basistechniken.rst b/documentations/structure/3-Grundlagen_und_Basistechniken.rst deleted file mode 100644 index 80b0a37..0000000 --- a/documentations/structure/3-Grundlagen_und_Basistechniken.rst +++ /dev/null @@ -1,7 +0,0 @@ -.. toctree:: - :glob: - :maxdepth: 3 - :caption: 3. Grundlagen und Basistechniken - - seminararbeiten/DevOps/Seminarpraesentation.ipynb - seminararbeiten/Datenspeicherung/00_Datenspeicherung diff --git a/documentations/structure/4-Technische_Realisierung.md b/documentations/structure/4-Technische_Realisierung.md new file mode 100644 index 0000000..5dc356f --- /dev/null +++ b/documentations/structure/4-Technische_Realisierung.md @@ -0,0 +1,2 @@ +# 4. Technische Realisierung +## 4.1 Dev Ops diff --git a/documentations/structure/4-Technische_Realisierung.rst b/documentations/structure/4-Technische_Realisierung.rst deleted file mode 100644 index 6a366c4..0000000 --- a/documentations/structure/4-Technische_Realisierung.rst +++ /dev/null @@ -1,3 +0,0 @@ -.. toctree:: - :maxdepth: 3 - :caption: 4. technische Realisierung diff --git a/documentations/structure/5-Zusammenfassung.md b/documentations/structure/5-Zusammenfassung.md new file mode 100644 index 0000000..1c84edd --- /dev/null +++ b/documentations/structure/5-Zusammenfassung.md @@ -0,0 +1 @@ +# 5. Zusammenfassung diff --git a/documentations/structure/5-Zusammenfassung.rst b/documentations/structure/5-Zusammenfassung.rst deleted file mode 100644 index 814eacf..0000000 --- a/documentations/structure/5-Zusammenfassung.rst +++ /dev/null @@ -1,3 +0,0 @@ -.. toctree:: - :maxdepth: 3 - :caption: 5. Zusammenfassung diff --git a/documentations/structure/6-Anhang.md b/documentations/structure/6-Anhang.md new file mode 100644 index 0000000..95f91a7 --- /dev/null +++ b/documentations/structure/6-Anhang.md @@ -0,0 +1,3 @@ +# 6. Anhang + + modules diff --git a/documentations/structure/6-Anhang.rst b/documentations/structure/6-Anhang.rst deleted file mode 100644 index 1f245a3..0000000 --- a/documentations/structure/6-Anhang.rst +++ /dev/null @@ -1,3 +0,0 @@ -.. toctree:: - :maxdepth: 3 - :caption: 6. Anhang