Adds documentation generators for tests.

HugoFara · Oct 1, 2024 · 09b00de · 09b00de
1 parent 1dd088b
commit 09b00de
Show file tree

Hide file tree

Showing 8 changed files with 137 additions and 2 deletions.
diff --git a/sphinx/index.rst b/sphinx/index.rst
@@ -14,10 +14,11 @@ Welcome to pylinkage's documentation!
    changeloglink
 
 .. toctree::
-   :maxdepth: 2
-   :caption: Modules
+   :maxdepth: 3
+   :caption: Packages
 
    api/modules
+   tests/modules
 
 .. toctree::
    :maxdepth: 2

diff --git a/sphinx/tests/modules.rst b/sphinx/tests/modules.rst
@@ -0,0 +1,7 @@
+tests
+=====
+
+.. toctree::
+   :maxdepth: 4
+
+   tests
diff --git a/sphinx/tests/tests.collections.rst b/sphinx/tests/tests.collections.rst
@@ -0,0 +1,21 @@
+tests.collections package
+=========================
+
+Submodules
+----------
+
+tests.collections.test\_collections module
+------------------------------------------
+
+.. automodule:: tests.collections.test_collections
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: tests.collections
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/sphinx/tests/tests.geometry.rst b/sphinx/tests/tests.geometry.rst
@@ -0,0 +1,21 @@
+tests.geometry package
+======================
+
+Submodules
+----------
+
+tests.geometry.test\_geometry module
+------------------------------------
+
+.. automodule:: tests.geometry.test_geometry
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: tests.geometry
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/sphinx/tests/tests.joints.rst b/sphinx/tests/tests.joints.rst
@@ -0,0 +1,21 @@
+tests.joints package
+====================
+
+Submodules
+----------
+
+tests.joints.test\_joints module
+--------------------------------
+
+.. automodule:: tests.joints.test_joints
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: tests.joints
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/sphinx/tests/tests.linkage.rst b/sphinx/tests/tests.linkage.rst
@@ -0,0 +1,21 @@
+tests.linkage package
+=====================
+
+Submodules
+----------
+
+tests.linkage.test\_linkage module
+----------------------------------
+
+.. automodule:: tests.linkage.test_linkage
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: tests.linkage
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/sphinx/tests/tests.optimization.rst b/sphinx/tests/tests.optimization.rst
@@ -0,0 +1,21 @@
+tests.optimization package
+==========================
+
+Submodules
+----------
+
+tests.optimization.test\_optimizer module
+-----------------------------------------
+
+.. automodule:: tests.optimization.test_optimizer
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: tests.optimization
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/sphinx/tests/tests.rst b/sphinx/tests/tests.rst
@@ -0,0 +1,22 @@
+tests package
+=============
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   tests.collections
+   tests.geometry
+   tests.joints
+   tests.linkage
+   tests.optimization
+
+Module contents
+---------------
+
+.. automodule:: tests
+   :members:
+   :undoc-members:
+   :show-inheritance: