add docs

2023-04-18 10:49:57 +02:00
parent da33aeae3a
commit 736c78fd64
17 changed files with 292 additions and 172 deletions
--- a/docs/source/_rst/code.rst
+++ b/docs/source/_rst/code.rst
@@ -15,4 +15,6 @@ Code Documentation
    SpatialProblem <spatialproblem.rst>
    TimeDependentProblem <timedepproblem.rst>
    Operators <operators.rst>
-    Plotter <plotter.rst>
+    Plotter <plotter.rst>
+    PINN <pinn.rst>
+    Condition <condition.rst>
--- a/docs/source/_rst/condition.rst
+++ b/docs/source/_rst/condition.rst
@@ -0,0 +1,12 @@
+Condition
+=========
+.. currentmodule:: pina.condition
+
+.. automodule:: pina.condition
+
+.. autoclass:: Condition
+    :members:
+    :private-members:
+    :undoc-members:
+    :show-inheritance:
+    :noindex:
--- a/docs/source/_rst/deeponet.rst
+++ b/docs/source/_rst/deeponet.rst
@@ -5,8 +5,6 @@ DeepONet
 .. automodule:: pina.model.deeponet

 .. autoclass:: DeepONet
-    :members:
-    :private-members:
-    :undoc-members:
-    :show-inheritance:
-    :noindex:
+   :members:
+   :private-members:
+   :show-inheritance:
--- a/docs/source/_rst/fnn.rst
+++ b/docs/source/_rst/fnn.rst
@@ -5,8 +5,6 @@ FeedForward
 .. automodule:: pina.model.feed_forward

 .. autoclass:: FeedForward
-    :members:
-    :private-members:
-    :undoc-members:
-    :show-inheritance:
-    :noindex:
+   :members:
+   :private-members:
+   :show-inheritance:
--- a/docs/source/_rst/label_tensor.rst
+++ b/docs/source/_rst/label_tensor.rst
@@ -5,8 +5,6 @@ LabelTensor
 .. automodule:: pina.label_tensor

 .. autoclass:: LabelTensor
-    :members:
-    :private-members:
-    :undoc-members:
-    :show-inheritance:
-    :noindex:
+   :members:
+   :private-members:
+   :show-inheritance:
--- a/docs/source/_rst/pinn.rst
+++ b/docs/source/_rst/pinn.rst
@@ -5,8 +5,6 @@ PINN
 .. automodule:: pina.pinn

 .. autoclass:: PINN
-    :members:
-    :private-members:
-    :undoc-members:
-    :show-inheritance:
-    :noindex:
+   :members:
+   :private-members:
+   :show-inheritance: