Documentation for v0.1 version (#199)

* Adding Equations, solving typos
* improve _code.rst
* the team rst and restuctore index.rst
* fixing errors

---------

Co-authored-by: Dario Coscia <dariocoscia@dhcp-015.eduroam.sissa.it>
This commit is contained in:
Dario Coscia
2023-11-08 14:39:00 +01:00
committed by Nicola Demo
parent 3f9305d475
commit 8b7b61b3bd
144 changed files with 2741 additions and 1766 deletions

View File

@@ -1,5 +1,5 @@
CartesianDomain
===========
======================
.. currentmodule:: pina.geometry.cartesian
.. automodule:: pina.geometry.cartesian

View File

@@ -0,0 +1,9 @@
Difference
======================
.. currentmodule:: pina.geometry.difference_domain
.. automodule:: pina.geometry.difference_domain
.. autoclass:: Difference
:members:
:show-inheritance:

View File

@@ -1,5 +1,5 @@
EllipsoidDomain
===========
======================
.. currentmodule:: pina.geometry.ellipsoid
.. automodule:: pina.geometry.ellipsoid

View File

@@ -0,0 +1,9 @@
Exclusion
======================
.. currentmodule:: pina.geometry.exclusion_domain
.. automodule:: pina.geometry.exclusion_domain
.. autoclass:: Exclusion
:members:
:show-inheritance:

View File

@@ -0,0 +1,9 @@
Intersection
======================
.. currentmodule:: pina.geometry.intersection_domain
.. automodule:: pina.geometry.intersection_domain
.. autoclass:: Intersection
:members:
:show-inheritance:

View File

@@ -1,10 +1,9 @@
Location
=========
====================
.. currentmodule:: pina.geometry.location
.. automodule:: pina.geometry.location
.. autoclass:: Location
:members:
:private-members:
:show-inheritance:

View File

@@ -0,0 +1,9 @@
OperationInterface
======================
.. currentmodule:: pina.geometry.operation_interface
.. automodule:: pina.geometry.operation_interface
.. autoclass:: OperationInterface
:members:
:show-inheritance:

View File

@@ -1,5 +1,5 @@
SimplexDomain
===========
======================
.. currentmodule:: pina.geometry.simplex
.. automodule:: pina.geometry.simplex

View File

@@ -0,0 +1,9 @@
Union
======================
.. currentmodule:: pina.geometry.union_domain
.. automodule:: pina.geometry.union_domain
.. autoclass:: Union
:members:
:show-inheritance: