mirror of
https://github.com/fhswf/aki_prj23_transparenzregister.git
synced 2025-06-21 15:03:56 +02:00
testing structure
This commit is contained in:
@ -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
|
||||
==============
|
||||
|
@ -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:
|
||||
|
3
documentations/structure/1-Einleitung.md
Normal file
3
documentations/structure/1-Einleitung.md
Normal file
@ -0,0 +1,3 @@
|
||||
# 1. Einleitung
|
||||
|
||||
## Projekt-Orga
|
@ -1,3 +0,0 @@
|
||||
.. toctree::
|
||||
:maxdepth: 3
|
||||
:caption: 1. Einleitung
|
3
documentations/structure/2-Recherche.md
Normal file
3
documentations/structure/2-Recherche.md
Normal file
@ -0,0 +1,3 @@
|
||||
# 2. Recherche
|
||||
|
||||
## 2.1.2 Untertest
|
@ -1,3 +0,0 @@
|
||||
.. toctree::
|
||||
:maxdepth: 3
|
||||
:caption: 2. Recherche
|
10
documentations/structure/3-Grundlagen_und_Basistechniken.md
Normal file
10
documentations/structure/3-Grundlagen_und_Basistechniken.md
Normal file
@ -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
|
@ -1,7 +0,0 @@
|
||||
.. toctree::
|
||||
:glob:
|
||||
:maxdepth: 3
|
||||
:caption: 3. Grundlagen und Basistechniken
|
||||
|
||||
seminararbeiten/DevOps/Seminarpraesentation.ipynb
|
||||
seminararbeiten/Datenspeicherung/00_Datenspeicherung
|
2
documentations/structure/4-Technische_Realisierung.md
Normal file
2
documentations/structure/4-Technische_Realisierung.md
Normal file
@ -0,0 +1,2 @@
|
||||
# 4. Technische Realisierung
|
||||
## 4.1 Dev Ops
|
@ -1,3 +0,0 @@
|
||||
.. toctree::
|
||||
:maxdepth: 3
|
||||
:caption: 4. technische Realisierung
|
1
documentations/structure/5-Zusammenfassung.md
Normal file
1
documentations/structure/5-Zusammenfassung.md
Normal file
@ -0,0 +1 @@
|
||||
# 5. Zusammenfassung
|
@ -1,3 +0,0 @@
|
||||
.. toctree::
|
||||
:maxdepth: 3
|
||||
:caption: 5. Zusammenfassung
|
3
documentations/structure/6-Anhang.md
Normal file
3
documentations/structure/6-Anhang.md
Normal file
@ -0,0 +1,3 @@
|
||||
# 6. Anhang
|
||||
|
||||
modules
|
@ -1,3 +0,0 @@
|
||||
.. toctree::
|
||||
:maxdepth: 3
|
||||
:caption: 6. Anhang
|
Reference in New Issue
Block a user