Issue #17: Updated gitignore, modified sphinx to utilize apidoc more

AVSLab · Dec 29, 2023 · 4bd0d42 · 4bd0d42
1 parent 0a5ddd7
commit 4bd0d42
Show file tree

Hide file tree

Showing 8 changed files with 6 additions and 191 deletions.
diff --git a/.gitignore b/.gitignore
@@ -29,6 +29,9 @@ wheels/
 *.egg-info/
 .installed.cfg
 *.egg
+# Dont track autogenerated docs
+docs/source/documentation
+
 
 # PyInstaller
 #  Usually these files are written by a python script from a template

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -24,6 +24,7 @@
     "sphinx.ext.todo",
     "sphinx.ext.autodoc",
     "sphinx.ext.viewcode",
+    "sphinx.ext.napoleon",
 ]
 
 templates_path = ["_templates"]
@@ -37,4 +38,4 @@
 html_static_path = ["_static"]
 html_css_files = ["custom.css"]
 
-add_module_names = False
+add_module_names = False
diff --git a/docs/source/general_satellite_tasking/general_satellite_tasking.rst b/docs/source/general_satellite_tasking/general_satellite_tasking.rst
diff --git a/docs/source/general_satellite_tasking/general_satellite_tasking.scenario.rst b/docs/source/general_satellite_tasking/general_satellite_tasking.scenario.rst
diff --git a/docs/source/general_satellite_tasking/general_satellite_tasking.simulation.rst b/docs/source/general_satellite_tasking/general_satellite_tasking.simulation.rst
diff --git a/docs/source/general_satellite_tasking/general_satellite_tasking.utils.rst b/docs/source/general_satellite_tasking/general_satellite_tasking.utils.rst
diff --git a/docs/source/general_satellite_tasking/modules.rst b/docs/source/general_satellite_tasking/modules.rst
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -17,7 +17,7 @@ Check out the :doc:`usage` section for further information.
    :maxdepth: 2
    :caption: Contents:
 
-   general_satellite_tasking/modules
+   documentation/modules
 
 
 Indices and tables