Adjust some of the links to work in the documentation. See #94.

README.md

@@ -96,7 +96,7 @@ If you want to build plotID yourself, follow these steps:
 1. Download the source code from [Gitlab](https://git.rwth-aachen.de/plotid/plotid_python):  
 `git clone https://git.rwth-aachen.de/plotid/plotid_python.git`  
 `cd plotid_python`  
-2. *[Optional]* Create a virtual environment (see [Installation](#Installation)).  
+2. *[Optional]* Create a virtual environment (see [Installation](#installation)).  
 3. *[Optional]* Run unittests and coverage:  
 `python3 tests/runner_tests.py`
 4. Build the package
@@ -110,4 +110,4 @@ To install all optional dependencies use `pip install .[test,docs]` or `pip inst
 
 ## Documentation
 If you have more questions about plotID, please have a look at the [documentation](https://plotid.pages.rwth-aachen.de/plotid_python).  
-Also have a look at the [examples](./examples) that are shipped with plotID.
+Also have a look at the [examples](https://git.rwth-aachen.de/plotid/plotid_python/-/tree/main/examples) that are shipped with plotID.

docs/source/about.rst

@@ -4,6 +4,6 @@ About plotID
 plotID is developed at the Institut Fluidsystemtechnik within nfdi4ing at the Technische Universität Darmstadt.
 
 Acknowledgements
----------------
+----------------
 
 The authors would like to thank the Federal Government and the Heads of Government of the Länder, as well as the Joint Science Conference (GWK), for their funding and support within the framework of the NFDI4Ing consortium. Funded by the German Research Foundation (DFG) - project number 442146713.
\ No newline at end of file

docs/source/conf.py

@@ -39,6 +39,7 @@ extensions = ["sphinx.ext.napoleon", "autoapi.extension", "myst_parser"]
 autoapi_type = "python"
 autoapi_dirs = ["../../plotid", "../../tests"]
 # autoapi_keep_files = True
+myst_heading_anchors = 2
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]

docs/source/structure.rst

 Structure and architecture of plotID
-==================================
+====================================
 
 A visualization of the internal structure of plotID is provided here. The structure tries to follow Object Oriented Programming (OOP) principles. First tagplot() is depicted with matplotlib as example plot engine: