fix(docs): Resolve missing images in Sphinx output (#499)

This commit is contained in:
Tristan Nolde 2024-01-01 14:31:56 +01:00 committed by GitHub
parent daffcadd11
commit 5a2f2b0e2c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 40 additions and 38 deletions

View File

@ -95,6 +95,8 @@ intersphinx_mapping: Final[dict[str, tuple[str, None]]] = {
"sqlalchemy": ("https://docs.sqlalchemy.org/en/14", None), "sqlalchemy": ("https://docs.sqlalchemy.org/en/14", None),
} }
myst_enable_extensions: Final[list[str]] = ["html_image"]
notfound_urls_prefix = "/" notfound_urls_prefix = "/"
myst_enable_extensions = ["dollarmath", "amsmath"] myst_enable_extensions = ["dollarmath", "amsmath"]

View File

@ -56,4 +56,4 @@ Sonstiges:
## Aktueller Projektstand ## Aktueller Projektstand
![alt text](https://github.com/fhswf/aki_prj23_transparenzregister/blob/meeting_notes_2023-05-04/documentations/meeting-notes/images/Project_2023-05-04.PNG) ![alt text](images/Project_2023-05-04.PNG)

View File

@ -7,38 +7,38 @@
## Inhaltsverzeichnis ## Inhaltsverzeichnis
- [Datenspeicherung](#datenspeicherung) - [Datenspeicherung](#datenspeicherung)
- [Inhaltsverzeichnis](#inhaltsverzeichnis) - [Inhaltsverzeichnis](#inhaltsverzeichnis)
- [Motivation: Warum speichern wird Daten?](#motivation-warum-speichern-wird-daten) - [Motivation: Warum speichern wird Daten?](#motivation-warum-speichern-wird-daten)
- [1. Allgemeine Anforderungen an Datenbank](#1-allgemeine-anforderungen-an-datenbank) - [1. Allgemeine Anforderungen an Datenbank](#1-allgemeine-anforderungen-an-datenbank)
- [2. Datenarten](#2-datenarten) - [2. Datenarten](#2-datenarten)
- [2.1 Welche Daten erwarten wir im Projekt?](#21-welche-daten-erwarten-wir-im-projekt) - [2.1 Welche Daten erwarten wir im Projekt?](#21-welche-daten-erwarten-wir-im-projekt)
- [2.2 strukturierte Daten](#22-strukturierte-daten) - [2.2 strukturierte Daten](#22-strukturierte-daten)
- [2.3 unstrukturierte Daten](#23-unstrukturierte-daten) - [2.3 unstrukturierte Daten](#23-unstrukturierte-daten)
- [3. Arten von Datenbanken](#3-arten-von-datenbanken) - [3. Arten von Datenbanken](#3-arten-von-datenbanken)
- [3.1 Relationale Datenbank](#31-relationale-datenbank) - [3.1 Relationale Datenbank](#31-relationale-datenbank)
- [3.1.1 Anlegen von Tabellen](#311-anlegen-von-tabellen) - [3.1.1 Anlegen von Tabellen](#311-anlegen-von-tabellen)
- [3.1.2 SQL - Abfrage von relationalen Datenbanken](#312-sql---abfrage-von-relationalen-datenbanken) - [3.1.2 SQL - Abfrage von relationalen Datenbanken](#312-sql---abfrage-von-relationalen-datenbanken)
- [3.2 Graphdatenbank](#32-graphdatenbank) - [3.2 Graphdatenbank](#32-graphdatenbank)
- [3.2.1 Erstellung eines Datensatzes](#321-erstellung-eines-datensatzes) - [3.2.1 Erstellung eines Datensatzes](#321-erstellung-eines-datensatzes)
- [3.2.2 Cypher - Abfrage von Graphdatenbanken](#322-cypher---abfrage-von-graphdatenbanken) - [3.2.2 Cypher - Abfrage von Graphdatenbanken](#322-cypher---abfrage-von-graphdatenbanken)
- [3.3 Zeitseriendatenbank](#33-zeitseriendatenbank) - [3.3 Zeitseriendatenbank](#33-zeitseriendatenbank)
- [3.3.1 Erstellung eines Datensatzes](#331-erstellung-eines-datensatzes) - [3.3.1 Erstellung eines Datensatzes](#331-erstellung-eines-datensatzes)
- [3.3.2 FluxQuery](#332-fluxquery) - [3.3.2 FluxQuery](#332-fluxquery)
- [3.4 Dokumenten Datenbank ](#34-dokumenten-datenbank-) - [3.4 Dokumenten Datenbank ](#34-dokumenten-datenbank-)
- [3.4.1 Erstellen einer Collection / Ablegen von Dokumenten](#341-erstellen-einer-collection--ablegen-von-dokumenten) - [3.4.1 Erstellen einer Collection / Ablegen von Dokumenten](#341-erstellen-einer-collection--ablegen-von-dokumenten)
- [3.5 Aufbau einer Datenbank](#35-aufbau-einer-datenbank) - [3.5 Aufbau einer Datenbank](#35-aufbau-einer-datenbank)
- [4. Datenbanken Transparenzregister](#4-datenbanken-transparenzregister) - [4. Datenbanken Transparenzregister](#4-datenbanken-transparenzregister)
- [4.1 Production DB - relationales Datenbankmodell](#41-production-db---relationales-datenbankmodell) - [4.1 Production DB - relationales Datenbankmodell](#41-production-db---relationales-datenbankmodell)
- [4.2 Staging DB](#42-staging-db) - [4.2 Staging DB](#42-staging-db)
- [4.3 SQL Alchemy](#43-sql-alchemy) - [4.3 SQL Alchemy](#43-sql-alchemy)
- [5. Proof of Concept](#5-proof-of-concept) - [5. Proof of Concept](#5-proof-of-concept)
- [5.1 Docker](#51-docker) - [5.1 Docker](#51-docker)
- [5.2 PG Admin](#52-pg-admin) - [5.2 PG Admin](#52-pg-admin)
- [5.3 Erstellen von Mock Daten](#53-erstellen-von-mock-daten) - [5.3 Erstellen von Mock Daten](#53-erstellen-von-mock-daten)
- [5.4 Anlegen der relationalen Tabellen](#54-anlegen-der-relationalen-tabellen) - [5.4 Anlegen der relationalen Tabellen](#54-anlegen-der-relationalen-tabellen)
- [5.5 Abfragen der Datenbank](#55-abfragen-der-datenbank) - [5.5 Abfragen der Datenbank](#55-abfragen-der-datenbank)
- [6. Zusammenfassung](#6-zusammenfassung) - [6. Zusammenfassung](#6-zusammenfassung)
- [Quellen](#quellen) - [Quellen](#quellen)
<div style="page-break-after: always;"></div> <div style="page-break-after: always;"></div>
@ -239,7 +239,7 @@ Unternehmen.
Die abgebildete Mindmap ist nicht vollständig und bildet nicht den finalen Datenumfang des Projekts ab. Es ist eine Die abgebildete Mindmap ist nicht vollständig und bildet nicht den finalen Datenumfang des Projekts ab. Es ist eine
Momentaufnahme, bevor das relationale Schema entwickelt und die Implementierung begonnen wurde. Momentaufnahme, bevor das relationale Schema entwickelt und die Implementierung begonnen wurde.
![Data_Clusters](/documentations/seminararbeiten/Datenspeicherung/images/Data_Cluster.PNG) ![Data_Clusters](images/Data_Cluster.PNG)
### 2.2 strukturierte Daten ### 2.2 strukturierte Daten
@ -436,7 +436,7 @@ CREATE
(u2)-[:cooparates_with]->(u1) (u2)-[:cooparates_with]->(u1)
``` ```
![Graph_example](images/Graph.png) ![Graph_example](images/Graph.PNG)
#### 3.2.2 Cypher - Abfrage von Graphdatenbanken #### 3.2.2 Cypher - Abfrage von Graphdatenbanken
@ -620,7 +620,7 @@ Es gibt verschiedene Quellen, mit unterschiedlichen Schnittstellen bzw. Zugriff
Web Scrapping. Web Scrapping.
Es wurde eine Architektur definiert, welche den Aufbau der späteren Software skizziert: Es wurde eine Architektur definiert, welche den Aufbau der späteren Software skizziert:
![High_level_design](images/HLD.png) ![High_level_design](images/HLD.PNG)
Mittels geeigneter Techniken werden Daten aus diversen Quellen extrahiert (Data Extraction) und in der Staging DB Mittels geeigneter Techniken werden Daten aus diversen Quellen extrahiert (Data Extraction) und in der Staging DB
gespeichert. gespeichert.
@ -633,7 +633,7 @@ Das Frontend kann auf diese strukturierten Daten zugreifen, um diese zu visualis
Für die Production DB ist eine relationale Datenbank vorgesehen, da diese die Daten organisiert und durch Verwendung von Für die Production DB ist eine relationale Datenbank vorgesehen, da diese die Daten organisiert und durch Verwendung von
definierten Schemata strukturiert. \ definierten Schemata strukturiert. \
Diese Strukturen erleichtern die Wartung und Integration zwischen Back- und Frontend. Diese Strukturen erleichtern die Wartung und Integration zwischen Back- und Frontend.
![Relationales Modell](images/DB_Schema.png) ![Relationales Modell](images/DB_Schema.PNG)
Zentrales Element ist die Stammdatentabelle **company**, welche einen zusammengesetzten Primärschlüssel aus der Nummer Zentrales Element ist die Stammdatentabelle **company**, welche einen zusammengesetzten Primärschlüssel aus der Nummer
des Handelsregisters und dem zuständigen Amtsgericht bildet. \ des Handelsregisters und dem zuständigen Amtsgericht bildet. \
@ -796,7 +796,7 @@ Um das Konzept und den Umgang mit den ausgewählten Datenbanken zu überprüfen,
werden. Hierfür wurde auf Statista recherchiert, welches die größten deutschen Unternehmen sind, um einen kleinen Stamm werden. Hierfür wurde auf Statista recherchiert, welches die größten deutschen Unternehmen sind, um einen kleinen Stamm
an Unternehmensdaten zu generieren (01_Stammdaten_Unternehmen_HR.csv). / an Unternehmensdaten zu generieren (01_Stammdaten_Unternehmen_HR.csv). /
Die Relation zu den Amtsgerichten ist frei erfunden und wurde nicht recherchiert. Die Relation zu den Amtsgerichten ist frei erfunden und wurde nicht recherchiert.
![biggest_companies](images/Statista_Companies.png) ![biggest_companies](images/Statista_Companies.PNG)
**Amtsgerichte:** **Amtsgerichte:**
Die Amtsgerichte sind aus https://www.gerichtsverzeichnis.de/ extrahiert, wobei lediglich 12 Amstgerichte eingefügt Die Amtsgerichte sind aus https://www.gerichtsverzeichnis.de/ extrahiert, wobei lediglich 12 Amstgerichte eingefügt