add docs

docs/Makefile

@@ -3,7 +3,7 @@
 
 # You can set these variables from the command line.
 SPHINXOPTS    =
-SPHINXBUILD   = sphinx-build
+SPHINXBUILD   = python -msphinx #sphinx-build
 PAPER         =
 BUILDDIR      = build
 

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>

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:

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:

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:

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:

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:

docs/source/conf.py

@@ -36,28 +36,28 @@ import pina
 # ones.
 extensions = [
     'sphinx.ext.autodoc',
-    'sphinx.ext.autosummary',
-    'sphinx.ext.coverage',
-    'sphinx.ext.graphviz',
-    'sphinx.ext.doctest',
+    #'sphinx.ext.autosummary',
+    #'sphinx.ext.coverage',
+    #'sphinx.ext.graphviz',
+    #'sphinx.ext.doctest',
     'sphinx.ext.intersphinx',
     'sphinx.ext.todo',
-    'sphinx.ext.coverage',
+    #'sphinx.ext.coverage',
     'sphinx.ext.viewcode',
-    'sphinx.ext.ifconfig',
+    #'sphinx.ext.ifconfig',
     'sphinx.ext.mathjax',
 ]
-autosummary_generate = True
+#autosummary_generate = True
 
 intersphinx_mapping = {
-    'python': ('http://docs.python.org/2', None),
+    'python': ('http://docs.python.org/3', None),
     'numpy': ('http://docs.scipy.org/doc/numpy/', None),
     'scipy': ('http://docs.scipy.org/doc/scipy/reference/', None),
     'matplotlib': ('http://matplotlib.sourceforge.net/', None),
     'torch': ('https://pytorch.org/docs/stable/', None),
-    'pina': ('https://mathlab.github.io/PINA/', None)
 }
 
+nitpicky = True
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 

docs/source/index.rst

@@ -14,11 +14,11 @@ learning tasks while respecting any given law of physics described by general
 nonlinear differential equations. Proposed in "Physics-informed neural
 networks: A deep learning framework for solving forward and inverse problems
 involving nonlinear partial differential equations", such framework aims to
-solve problems in a continuous and nonlinear settings.
+solve problems in a continuous and nonlinear settings. :py:class:`pina.pinn.PINN`
 
 
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 2
    :caption: Package Documentation:
 
    Installation <_rst/installation>