From 09b00de33c354c893cd63c750d9b95e435523820 Mon Sep 17 00:00:00 2001 From: HugoFara Date: Tue, 1 Oct 2024 22:19:08 +0200 Subject: [PATCH] Adds documentation generators for tests. --- sphinx/index.rst | 5 +++-- sphinx/tests/modules.rst | 7 +++++++ sphinx/tests/tests.collections.rst | 21 +++++++++++++++++++++ sphinx/tests/tests.geometry.rst | 21 +++++++++++++++++++++ sphinx/tests/tests.joints.rst | 21 +++++++++++++++++++++ sphinx/tests/tests.linkage.rst | 21 +++++++++++++++++++++ sphinx/tests/tests.optimization.rst | 21 +++++++++++++++++++++ sphinx/tests/tests.rst | 22 ++++++++++++++++++++++ 8 files changed, 137 insertions(+), 2 deletions(-) create mode 100644 sphinx/tests/modules.rst create mode 100644 sphinx/tests/tests.collections.rst create mode 100644 sphinx/tests/tests.geometry.rst create mode 100644 sphinx/tests/tests.joints.rst create mode 100644 sphinx/tests/tests.linkage.rst create mode 100644 sphinx/tests/tests.optimization.rst create mode 100644 sphinx/tests/tests.rst diff --git a/sphinx/index.rst b/sphinx/index.rst index 1928131..f576d95 100644 --- 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 new file mode 100644 index 0000000..8529a1d --- /dev/null +++ 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 new file mode 100644 index 0000000..12a1e35 --- /dev/null +++ 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 new file mode 100644 index 0000000..074d0a0 --- /dev/null +++ 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 new file mode 100644 index 0000000..d9fbeb1 --- /dev/null +++ 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 new file mode 100644 index 0000000..58ea2e2 --- /dev/null +++ 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 new file mode 100644 index 0000000..62846fb --- /dev/null +++ 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 new file mode 100644 index 0000000..aaa1de4 --- /dev/null +++ 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: