#68 update and fix documentation

- Insert supported by - Remove list of tables and index - Insert logo in header - Insert link to github organization - update doxygen .xml
hygia-org · Feb 10, 2023 · 4a3f3cb · 4a3f3cb
1 parent 8373423
commit 4a3f3cb
Show file tree

Hide file tree

Showing 47 changed files with 2,858 additions and 2,693 deletions.
diff --git a/docs/.doctrees/doxygen/index.doctree b/docs/.doctrees/doxygen/index.doctree
diff --git a/docs/.doctrees/getting_started/index.doctree b/docs/.doctrees/getting_started/index.doctree
diff --git a/docs/Doxyfile b/docs/Doxyfile
@@ -225,7 +225,7 @@ MULTILINE_CPP_IS_BRIEF = NO
 # documentation blocks is shown as doxygen documentation.
 # The default value is: YES.
 
-PYTHON_DOCSTRING = YES
+PYTHON_DOCSTRING = NO
 
 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
 # documentation from any documented member that it re-implements.

diff --git a/docs/README.md b/docs/README.md
@@ -1,23 +1,28 @@
 ### Documentation
 
-We used sphinx to write the documentation
-
-To run locally, you need to install sphinx:
+We utilized Sphinx and Doxygen to compose our documentation. To access it locally, you'll need to install both tools by running the following commands:
 
 ```
 pip install sphinx
+pip install doxygen-junit
 ```
 
-Then install the theme used:
+Additionally, you'll need to install the theme we used:
 
 ```
 pip install pydata-sphinx-theme
 ```
 
-And Run the project
+After completing these steps, navigate to the /docs folder and run the project.
+
+To ensure that the documentation for classes and functions remains up-to-date, run:
+```
+doxygen
+```
 
+To generate the HTML version of the documentation, run:
 ```
 sphinx-build -b html source ./
 ```
 
-And open the index.html
+Finally, open the index.html file to access the documentation."
diff --git a/docs/_sources/doxygen/index.rst.txt b/docs/_sources/doxygen/index.rst.txt
@@ -26,11 +26,3 @@ library and take your data processing to the next level.
 
  getting_started/index
  user_guide/index
-
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
diff --git a/docs/_sources/getting_started/index.rst.txt b/docs/_sources/getting_started/index.rst.txt
@@ -52,12 +52,3 @@ Installing from PyPI
 
  user_guide/index
  doxygen/index
-
-
-
-.. Indices and tables
- ==================
-
- * :ref:`genindex`
- * :ref:`modindex`
- * :ref:`search`
diff --git a/docs/_static/horizontal_logo.PNG b/docs/_static/horizontal_logo.PNG
diff --git a/docs/_static/horizontal_logo_dark.png b/docs/_static/horizontal_logo_dark.png
diff --git a/docs/_static/horizontal_logo_light.png b/docs/_static/horizontal_logo_light.png
diff --git a/docs/_static/logo_eldorado.png b/docs/_static/logo_eldorado.png
diff --git a/docs/_static/logo_lappis.png b/docs/_static/logo_lappis.png
diff --git a/docs/_static/logo_unb.svg b/docs/_static/logo_unb.svg