Minor updates

Author: faressc

docs/CMakeLists.txt

@@ -55,6 +55,9 @@ else (SPHINX_EXECUTABLE)
     message(WARNING "Sphinx need to be installed to generate the sphinx documentation")
 endif (SPHINX_EXECUTABLE)
 
+# Here we build .rst files from the Doxygen XML output using Breathe
+# Since the toctree directive is used in the index.rst, we need to put the generated files in the same directory as the index.rst
+# Therefore add the files to our version control system and build them only occasionally
 find_program(BREATHE_EXECUTABLE
     NAMES breathe-apidoc
     DOC "Path to breathe-apidoc executable")

docs/sphinx/index.rst

@@ -6,7 +6,7 @@ anira Documentation
    :align: center
    :width: 800px
 
-|build_test| |build_benchmark| |build_examples| |on_tag|
+|build_test| |build_benchmark| |build_examples| |build_docs| |on_tag|
 
 .. |build_test| image:: https://github.com/anira-project/anira/actions/workflows/build_test.yml/badge.svg
    :target: https://github.com/anira-project/anira/actions/workflows/build_test.yml