From 7e057926345e977ffdd41b577d95a9bd7254d57a Mon Sep 17 00:00:00 2001 From: Philipp Horstenkamp Date: Sun, 31 Dec 2023 16:02:57 +0100 Subject: [PATCH] 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 --- documentations/conf.py | 8 ++- documentations/index.rst | 64 +++++++++---------- .../research/Timeseries/Overview.md | 2 +- .../Datenspeicherung/00_Datenspeicherung.md | 2 +- 4 files changed, 38 insertions(+), 38 deletions(-) diff --git a/documentations/conf.py b/documentations/conf.py index 96c13aa..e6c35f9 100644 --- a/documentations/conf.py +++ b/documentations/conf.py @@ -52,7 +52,6 @@ extensions: Final[list[str]] = [ exclude_patterns: Final[list[str]] = ["_build", "Thumbs.db", ".DS_Store", "templates"] root_doc: Final[str] = "index" -# master_doc = "index" autodoc_default_flags: Final[list[str]] = [ "members", @@ -64,7 +63,7 @@ autodoc_default_options: Final[dict[str, bool]] = { _: True for _ in autodoc_default_flags } autodoc_typehints: Final[str] = "signature" -simplify_optional_unions: Final[bool] = True +simplify_optional_unions: Final[bool] = False typehint_defaults: Final[str] = "comma" source_suffix: Final[list[str]] = [".rst", ".md"] mermaid_output_format: Final[str] = "raw" @@ -91,9 +90,12 @@ intersphinx_mapping: Final[dict[str, tuple[str, None]]] = { "scikit-learn": ("https://scikit-learn.org/stable/", None), "sphinx": ("https://docs.sympy.org/latest/", None), "plotly": ("https://plotly.com/python-api-reference/", None), - "networkx": ("https://networkx.org/documentation/networkx-0.37/", None), + "networkx": ("https://networkx.org/documentation/stable/", None), "scipy": ("https://docs.scipy.org/doc/scipy/reference/", None), "sqlalchemy": ("https://docs.sqlalchemy.org/en/14", None), } notfound_urls_prefix = "/" + +myst_enable_extensions = ["dollarmath", "amsmath"] +drawio_default_transparency = True diff --git a/documentations/index.rst b/documentations/index.rst index e0e2708..6ff161e 100644 --- a/documentations/index.rst +++ b/documentations/index.rst @@ -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` diff --git a/documentations/research/Timeseries/Overview.md b/documentations/research/Timeseries/Overview.md index 1889e87..062e890 100644 --- a/documentations/research/Timeseries/Overview.md +++ b/documentations/research/Timeseries/Overview.md @@ -81,7 +81,7 @@ mehrere Datenquellen (siehe oben angesprochene `Polyglot Persistence`) kombinier ### Überblick über Datenrelationen -```mermaid +```{mermaid} erDiagram Kapitalgesellschaft ||--o{ Jahresabschluss : veroeffentlicht diff --git a/documentations/seminararbeiten/Datenspeicherung/00_Datenspeicherung.md b/documentations/seminararbeiten/Datenspeicherung/00_Datenspeicherung.md index 1f3ebef..081f423 100644 --- a/documentations/seminararbeiten/Datenspeicherung/00_Datenspeicherung.md +++ b/documentations/seminararbeiten/Datenspeicherung/00_Datenspeicherung.md @@ -250,7 +250,7 @@ repräsentiert. Die Beziehungen untereinander sind über die Entitäten definier Das Beispiel unten zeigt ein einfaches Beispiel, wie die Daten für die Klasse *Company* definiert sind. Mit diesem Schema kann die Datenaufbereitung umgesetzt werden. -```mermaid +```{mermaid} --- title: Structured Data ---