From 0e22ae5538e96d7b4ebb03968b5aea5db9401201 Mon Sep 17 00:00:00 2001
From: "Acciarini, Giacomo (PG/R - Maths & Physics)" <g.acciarini@surrey.ac.uk>
Date: Mon, 25 Nov 2024 10:50:47 +0100
Subject: [PATCH] update docs

---
 doc/_templates/custom-class-template.rst | 25 ------------------------
 doc/api.rst                              |  9 +++++++--
 doc/conf.py                              |  3 ++-
 doc/dsgp4.mldsgp4.rst                    | 13 ++++++++++++
 4 files changed, 22 insertions(+), 28 deletions(-)
 delete mode 100644 doc/_templates/custom-class-template.rst
 create mode 100644 doc/dsgp4.mldsgp4.rst

diff --git a/doc/_templates/custom-class-template.rst b/doc/_templates/custom-class-template.rst
deleted file mode 100644
index 935d875..0000000
--- a/doc/_templates/custom-class-template.rst
+++ /dev/null
@@ -1,25 +0,0 @@
-{{ fullname | escape | underline }}
-
-.. currentmodule:: {{ module }}
-
-.. autoclass:: {{ objname }}
-   :members:
-   :special-members: __init__, __call__
-
-.. rubric:: Methods
-
-.. autosummary::
-   {% for item in members %}
-      {% if item not in parent_members %}
-         ~{{ name }}.{{ item }}
-      {% endif %}
-   {% endfor %}
-
-.. rubric:: Attributes
-
-.. autosummary::
-   {% for item in attributes %}
-      {% if item not in parent_attributes %}
-         ~{{ name }}.{{ item }}
-      {% endif %}
-   {% endfor %}
\ No newline at end of file
diff --git a/doc/api.rst b/doc/api.rst
index 8a67293..a10fd81 100644
--- 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
\ No newline at end of file
diff --git a/doc/conf.py b/doc/conf.py
index d1fea73..e29fa08 100644
--- 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
new file mode 100644
index 0000000..8068314
--- /dev/null
+++ 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__
\ No newline at end of file