Merge pull request #94 from stefanDeveloper/documentation/rc1-developer-guide

Add developer guide section to readthedocs for better structure

Author: stefanDeveloper

docs/developer_guide.rst

@@ -0,0 +1,17 @@
+Developer Guide
+===============
+
+This section describes useful information for contributors of the project.
+
+Commit Hook
+------------
+
+Contributing to the project you might be noting failed pipeline runs.
+This can be due to the pre-commit hook finding errors in the formatting. Therefore, we suggest you run
+
+.. code-block:: console
+
+   (.venv) pre-commit run --show-diff-on-failure --color=always --all-files
+
+before committing your changes to GitHub.
+This reformates the code accordingly, preventing errors in the pipeline.

docs/index.rst

@@ -24,5 +24,6 @@ Contents
    pipeline
    monitoring
    training
+   developer_guide
    api/index
    references

docs/usage.rst

@@ -49,21 +49,6 @@ Now, you can start each module, e.g. the `Inspector`:
 
    (.venv) $ python src/inspector/main.py
 
-
-Commit Hook
-------------
-
-Contributing to the project you might be noting failed pipeline runs.
-This can be due to the pre.commit hook finding errors in the formatting. Therefore, we suggest you run
-
-.. code-block:: console
-
-   (.venv) pre-commit run --show-diff-on-failure --color=always --all-files
-
-before committing your changes to GitHub.
-This reformates the code accordingly, preventing errors in the pipeline.
-
-
 Configuration
 -------------