Simplify autodoc derectives

ComputationalScienceLaboratory · Mar 31, 2024 · bcfe045 · bcfe045
1 parent 384e2fe
commit bcfe045
Show file tree

Hide file tree

Showing 5 changed files with 4 additions and 13 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -25,7 +25,6 @@
 
 primary_domain = 'mat'
 matlab_src_dir = '../toolbox'
-matlab_keep_package_prefix = False
 matlab_auto_link = 'basic'
 
 autodoc_default_options = {

diff --git a/docs/generate_problem_rst.py b/docs/generate_problem_rst.py
@@ -16,7 +16,7 @@
         stream.write(f'''
 {problem_name}
 ================================================================================
-.. automodule:: +otp.{problem.parent.name}
+.. module:: +otp.{problem.parent.name}
 .. autoclass:: {problem.stem}
     :members:
 
@@ -28,10 +28,5 @@
 Presets
 --------------------------------------------------------------------------------
 .. automodule:: +otp.{problem.parent.name}.+presets
-''')
-
-        for preset in sorted(problem.parent.glob('+presets/*.m')):
-            stream.write(f'''
-.. autoclass:: {preset.stem}
     :members:
 ''')
diff --git a/docs/structure/parameters.rst b/docs/structure/parameters.rst
@@ -1,6 +1,5 @@
 Parameters
 ================================================================================
 
-.. automodule:: +otp
-.. autoclass:: Parameters
+.. autoclass:: +otp.Parameters
     :members:
diff --git a/docs/structure/problem.rst b/docs/structure/problem.rst
@@ -1,6 +1,5 @@
 Problem
 ================================================================================
 
-.. automodule:: +otp
-.. autoclass:: Problem
+.. autoclass:: +otp.Problem
     :members:
diff --git a/docs/structure/rhs.rst b/docs/structure/rhs.rst
@@ -1,6 +1,5 @@
 RHS
 ================================================================================
 
-.. automodule:: +otp
-.. autoclass:: RHS
+.. autoclass:: +otp.RHS
     :members: