From 365fea82f476e0419b105eb4d85ca3549b17daed Mon Sep 17 00:00:00 2001
From: "Olivier J.N. Bertrand" <olivier.bertrand@uni-bielefeld.de>
Date: Fri, 23 Mar 2018 19:33:25 +0100
Subject: [PATCH] Documents test
The doc is now containing an item test, which will contains a list of all test written so far
---
doc/source/index.rst | 2 +-
doc/source/references/index.rst | 1 +
doc/source/references/maths.rst | 47 +++++++++++++++++++
doc/source/references/processing.rst | 4 +-
doc/source/tests/brain.rst | 4 ++
doc/source/tests/comparing.rst | 5 ++
doc/source/tests/database.rst | 5 ++
doc/source/tests/index.rst | 14 ++++++
doc/source/tests/maths.rst | 41 ++++++++++++++++
doc/source/tests/moving.rst | 14 ++++++
doc/source/tests/processing.rst | 5 ++
doc/source/tests/sensors.rst | 4 ++
...py => test_homogeneous_transformations.py} | 0
.../{test_random_cust.py => test_random.py} | 0
14 files changed, 143 insertions(+), 3 deletions(-)
create mode 100644 doc/source/references/maths.rst
create mode 100644 doc/source/tests/brain.rst
create mode 100644 doc/source/tests/comparing.rst
create mode 100644 doc/source/tests/database.rst
create mode 100644 doc/source/tests/index.rst
create mode 100644 doc/source/tests/maths.rst
create mode 100644 doc/source/tests/moving.rst
create mode 100644 doc/source/tests/processing.rst
create mode 100644 doc/source/tests/sensors.rst
rename navipy/maths/{test_homogenous_transformations.py => test_homogeneous_transformations.py} (100%)
rename navipy/maths/{test_random_cust.py => test_random.py} (100%)
diff --git a/doc/source/index.rst b/doc/source/index.rst
index d87a51c..0ccef0d 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -26,7 +26,7 @@ Content
overview/index
tutorials/index
references/index
-
+ tests/index
Indices and tables
==================
diff --git a/doc/source/references/index.rst b/doc/source/references/index.rst
index b3fbe6c..03c6eb7 100644
--- a/doc/source/references/index.rst
+++ b/doc/source/references/index.rst
@@ -10,3 +10,4 @@ References
comparing
moving
database
+ maths
diff --git a/doc/source/references/maths.rst b/doc/source/references/maths.rst
new file mode 100644
index 0000000..79140eb
--- /dev/null
+++ b/doc/source/references/maths.rst
@@ -0,0 +1,47 @@
+Maths
+=====
+
+.. automodule:: navipy.maths
+ :members:
+
+Constants
+---------
+
+.. automodule:: navipy.maths.constants
+ :members:
+
+Coordinates
+-----------
+
+.. automodule:: navipy.maths.coordinates
+ :members:
+
+Homogeneous transformations
+---------------------------
+
+.. automodule:: navipy.maths.homogeneous_transformations
+ :members:
+
+Euler
+~~~~~
+
+.. automodule:: navipy.maths.euler
+ :members:
+
+Quaternions
+~~~~~~~~~~~
+
+.. automodule:: navipy.maths.quaternion
+ :members:
+
+Random generator
+----------------
+
+.. automodule:: navipy.maths.random
+ :members:
+
+Tools
+-----
+
+.. automodule:: navipy.maths.tools
+ :members:
diff --git a/doc/source/references/processing.rst b/doc/source/references/processing.rst
index 6f3291b..19ca92d 100644
--- a/doc/source/references/processing.rst
+++ b/doc/source/references/processing.rst
@@ -1,10 +1,10 @@
Processing
-----------
+==========
.. automodule:: navipy.processing
Place code
-~~~~~~~~~~
+----------
.. automodule:: navipy.processing.pcode
:members:
diff --git a/doc/source/tests/brain.rst b/doc/source/tests/brain.rst
new file mode 100644
index 0000000..ce79949
--- /dev/null
+++ b/doc/source/tests/brain.rst
@@ -0,0 +1,4 @@
+Brain
+=====
+
+No test...
diff --git a/doc/source/tests/comparing.rst b/doc/source/tests/comparing.rst
new file mode 100644
index 0000000..7538131
--- /dev/null
+++ b/doc/source/tests/comparing.rst
@@ -0,0 +1,5 @@
+Comparing
+=========
+
+.. automodule:: navipy.comparing.test
+ :members:
diff --git a/doc/source/tests/database.rst b/doc/source/tests/database.rst
new file mode 100644
index 0000000..a2fbbc8
--- /dev/null
+++ b/doc/source/tests/database.rst
@@ -0,0 +1,5 @@
+Database
+========
+
+.. automodule:: navipy.database.test
+ :members:
diff --git a/doc/source/tests/index.rst b/doc/source/tests/index.rst
new file mode 100644
index 0000000..c27dd65
--- /dev/null
+++ b/doc/source/tests/index.rst
@@ -0,0 +1,14 @@
+=====
+Tests
+=====
+
+.. toctree::
+ :maxdepth: 2
+
+ brain
+ sensors
+ processing
+ comparing
+ moving
+ database
+ maths
diff --git a/doc/source/tests/maths.rst b/doc/source/tests/maths.rst
new file mode 100644
index 0000000..2f12083
--- /dev/null
+++ b/doc/source/tests/maths.rst
@@ -0,0 +1,41 @@
+Maths
+=====
+
+Constants
+---------
+
+No Test
+
+Coordinates
+-----------
+
+No Test
+
+Homogeneous transformations
+---------------------------
+
+.. automodule:: navipy.maths.test_homogeneous_transformations
+ :members:
+
+Euler
+~~~~~
+
+.. automodule:: navipy.maths.test_euler
+ :members:
+
+Quaternions
+~~~~~~~~~~~
+
+.. automodule:: navipy.maths.test_quaternion
+ :members:
+
+Random generator
+----------------
+
+.. automodule:: navipy.maths.test_random
+ :members:
+
+Tools
+-----
+
+No Test Yet
diff --git a/doc/source/tests/moving.rst b/doc/source/tests/moving.rst
new file mode 100644
index 0000000..7edeb2d
--- /dev/null
+++ b/doc/source/tests/moving.rst
@@ -0,0 +1,14 @@
+Moving
+======
+
+Agents
+~~~~~~
+
+.. automodule:: navipy.moving.test_agent
+ :members:
+
+Maths
+~~~~~
+
+.. automodule:: navipy.moving.test_maths
+ :members:
diff --git a/doc/source/tests/processing.rst b/doc/source/tests/processing.rst
new file mode 100644
index 0000000..0eb1605
--- /dev/null
+++ b/doc/source/tests/processing.rst
@@ -0,0 +1,5 @@
+Processing
+==========
+
+.. automodule:: navipy.processing.test
+ :members:
diff --git a/doc/source/tests/sensors.rst b/doc/source/tests/sensors.rst
new file mode 100644
index 0000000..f9e3f91
--- /dev/null
+++ b/doc/source/tests/sensors.rst
@@ -0,0 +1,4 @@
+Sensors
+-------
+
+No test here ...
diff --git a/navipy/maths/test_homogenous_transformations.py b/navipy/maths/test_homogeneous_transformations.py
similarity index 100%
rename from navipy/maths/test_homogenous_transformations.py
rename to navipy/maths/test_homogeneous_transformations.py
diff --git a/navipy/maths/test_random_cust.py b/navipy/maths/test_random.py
similarity index 100%
rename from navipy/maths/test_random_cust.py
rename to navipy/maths/test_random.py
--
GitLab