Tutorials and Doc (#191)

* Tutorial doc update * update doc tutorial * doc not compiling --------- Co-authored-by: Dario Coscia <dcoscia@euclide.maths.sissa.it> Co-authored-by: Dario Coscia <dariocoscia@Dario-Coscia.local>
2023-10-23 12:48:09 +02:00
parent ac829aece9
commit 0c8072274e
93 changed files with 2306 additions and 1685 deletions
--- a/docs/source/_rst/geometry/cartesian.rst
+++ b/docs/source/_rst/geometry/cartesian.rst
@@ -0,0 +1,10 @@
+CartesianDomain
+===========
+.. currentmodule:: pina.geometry.cartesian
+
+.. automodule:: pina.geometry.cartesian
+
+.. autoclass:: CartesianDomain
+    :members:
+    :show-inheritance:
+    :noindex:
--- a/docs/source/_rst/geometry/ellipsoid.rst
+++ b/docs/source/_rst/geometry/ellipsoid.rst
@@ -0,0 +1,10 @@
+EllipsoidDomain
+===========
+.. currentmodule:: pina.geometry.ellipsoid
+
+.. automodule:: pina.geometry.ellipsoid
+
+.. autoclass:: EllipsoidDomain
+    :members:
+    :show-inheritance:
+    :noindex:
--- a/docs/source/_rst/geometry/location.rst
+++ b/docs/source/_rst/geometry/location.rst
@@ -0,0 +1,10 @@
+Location
+=========
+.. currentmodule:: pina.geometry.location
+
+.. automodule:: pina.geometry.location
+
+.. autoclass:: Location
+    :members:
+    :private-members:
+    :show-inheritance:
--- a/docs/source/_rst/geometry/simplex.rst
+++ b/docs/source/_rst/geometry/simplex.rst
@@ -0,0 +1,10 @@
+SimplexDomain
+===========
+.. currentmodule:: pina.geometry.simplex
+
+.. automodule:: pina.geometry.simplex
+
+.. autoclass:: SimplexDomain
+    :members:
+    :show-inheritance:
+    :noindex: