update docs

esa · Nov 25, 2024 · 0e22ae5 · 0e22ae5
1 parent c721bb6
commit 0e22ae5
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 28 deletions.
diff --git a/doc/_templates/custom-class-template.rst b/doc/_templates/custom-class-template.rst
diff --git a/doc/api.rst b/doc/api.rst
@@ -54,6 +54,11 @@ $\partial$SGP4 API
    newton_method
    sgp4init
    sgp4init_batch
-   mldsgp4
-   mldsgp4.mldsgp4
 
+.. currentmodule:: dsgp4
+
+.. toctree::
+   :maxdepth: 2
+   :caption: dsgp4 ML-dSGP4 Module
+
+   dsgp4.mldsgp4
diff --git a/doc/conf.py b/doc/conf.py
@@ -25,7 +25,7 @@
 import dsgp4
 import sys
 import os
-sys.path.insert(0, os.path.abspath('../dsgp4'))
+sys.path.insert(0, os.path.abspath('../'))  # Add the root directory of your repo
 
 release = dsgp4.__version__
 
@@ -105,6 +105,7 @@
     "covariance_propagation.ipynb",
     "mldsgp4.ipynb"
 ]
+autosummary_ignore_module = ['dsgp4.mldsgp4']
 
 latex_engine = "xelatex"
 

diff --git a/doc/dsgp4.mldsgp4.rst b/doc/dsgp4.mldsgp4.rst
@@ -0,0 +1,13 @@
+.. _mldsgp4:
+
+mldsgp4 model
+##############
+
+This module defines the ``mldsgp4`` class within the ``dsgp4`` library.
+
+.. currentmodule:: dsgp4
+
+.. autoclass:: dsgp4.mldsgp4.mldsgp4
+   :members: __init__, forward, load_model
+   :undoc-members:
+   :exclude-members: __del__