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/problem/abstractproblem.rst
+++ b/docs/source/_rst/problem/abstractproblem.rst
@@ -0,0 +1,11 @@
+AbstractProblem
+===============
+.. currentmodule:: pina.problem.abstract_problem
+
+.. automodule:: pina.problem.abstract_problem
+
+.. autoclass:: AbstractProblem
+    :members:
+    :private-members:
+    :undoc-members:
+    :show-inheritance:
--- a/docs/source/_rst/problem/parametricproblem.rst
+++ b/docs/source/_rst/problem/parametricproblem.rst
@@ -0,0 +1,10 @@
+ParametricProblem
+=================
+.. currentmodule:: pina.problem.parametric_problem
+
+.. automodule:: pina.problem.parametric_problem
+
+.. autoclass:: ParametricProblem
+    :members:
+    :private-members:
+    :show-inheritance:
--- a/docs/source/_rst/problem/spatialproblem.rst
+++ b/docs/source/_rst/problem/spatialproblem.rst
@@ -0,0 +1,11 @@
+SpatialProblem
+==============
+.. currentmodule:: pina.problem.spatial_problem
+
+.. automodule:: pina.problem.spatial_problem
+
+.. autoclass:: SpatialProblem
+    :members:
+    :private-members:
+    :undoc-members:
+    :show-inheritance:
--- a/docs/source/_rst/problem/timedepproblem.rst
+++ b/docs/source/_rst/problem/timedepproblem.rst
@@ -0,0 +1,11 @@
+TimeDependentProblem
+====================
+.. currentmodule:: pina.problem.timedep_problem
+
+.. automodule:: pina.problem.timedep_problem
+
+.. autoclass:: TimeDependentProblem
+    :members:
+    :private-members:
+    :undoc-members:
+    :show-inheritance: