[docs] Add auto API generator

.gitignore

@@ -30,4 +30,5 @@ related-projects.md
 docs/**/*.dat
 docs/**/*.npz
 
-.DS_Store
+.DS_Store
+docs/apis/generated/

docs/_templates/classtemplate.rst

@@ -0,0 +1,9 @@
+.. role:: hidden
+    :class: hidden-section
+.. currentmodule:: {{ module }}
+
+
+{{ name | underline}}
+
+.. autoclass:: {{ name }}
+    :members:

docs/apis/pinnx.callbacks.rst

@@ -0,0 +1,26 @@
+``pinnx.callbacks`` module
+==========================
+
+.. currentmodule:: pinnx.callbacks
+.. automodule:: pinnx.callbacks
+
+Callbacks
+---------
+
+.. autosummary::
+   :toctree: generated/
+   :nosignatures:
+   :template: classtemplate.rst
+
+   Callback
+   CallbackList
+   ModelCheckpoint
+   EarlyStopping
+   Timer
+   DropoutUncertainty
+   VariableValue
+   OperatorPredictor
+   MovieDumper
+   PDEPointResampler
+
+

docs/apis/pinnx.fnspace.rst

@@ -0,0 +1,23 @@
+``pinnx.fnspace`` module
+========================
+
+.. currentmodule:: pinnx.fnspace
+.. automodule:: pinnx.fnspace
+
+Function Space
+--------------
+
+.. autosummary::
+   :toctree: generated/
+   :nosignatures:
+   :template: classtemplate.rst
+
+   wasserstein2
+   FunctionSpace
+   PowerSeries
+   Chebyshev
+   GRF
+   GRF_KL
+   GRF2D
+
+

docs/apis/pinnx.geometry.rst

@@ -0,0 +1,117 @@
+``pinnx.geometry`` module
+=========================
+
+.. currentmodule:: pinnx.geometry 
+.. automodule:: pinnx.geometry 
+
+Base Geometry Class
+-------------------
+
+.. autosummary::
+   :toctree: generated/
+   :nosignatures:
+   :template: classtemplate.rst
+
+   AbstractGeometry
+   Geometry
+   CSGUnion
+   CSGDifference
+   CSGIntersection
+
+
+Geometry in 1D
+--------------
+
+.. autosummary::
+   :toctree: generated/
+   :nosignatures:
+   :template: classtemplate.rst
+
+   sample
+   Geometry
+   Interval
+   Literal
+   Union
+
+
+Geometry in 2D
+--------------
+
+.. autosummary::
+   :toctree: generated/
+   :nosignatures:
+   :template: classtemplate.rst
+
+   Disk
+   Ellipse
+   Polygon
+   Rectangle
+   StarShaped
+   Triangle
+
+
+Geometry in 3D
+--------------
+
+.. autosummary::
+   :toctree: generated/
+   :nosignatures:
+   :template: classtemplate.rst
+
+   Rectangle
+   Hypercube
+   Hypersphere
+   Cuboid
+   Sphere
+   Union
+   Literal
+
+
+Geometry in ND
+--------------
+
+.. autosummary::
+   :toctree: generated/
+   :nosignatures:
+   :template: classtemplate.rst
+
+   sample
+   isclose
+   Geometry
+   Hypercube
+   Hypersphere
+   Literal
+
+
+Point Cloud
+-----------
+
+.. autosummary::
+   :toctree: generated/
+   :nosignatures:
+   :template: classtemplate.rst
+
+   isclose
+   BatchSampler
+   Geometry
+   PointCloud
+
+
+Time Domain
+-----------
+
+.. autosummary::
+   :toctree: generated/
+   :nosignatures:
+   :template: classtemplate.rst
+
+   isclose
+   AbstractGeometry
+   Interval
+   Rectangle
+   Cuboid
+   Hypercube
+   TimeDomain
+   GeometryXTime
+
+

docs/apis/pinnx.grad.rst

@@ -0,0 +1,19 @@
+``pinnx.grad`` module
+=====================
+
+.. currentmodule:: pinnx.grad
+.. automodule:: pinnx.grad
+
+Automatic Differentiation
+-------------------------
+
+.. autosummary::
+   :toctree: generated/
+   :nosignatures:
+   :template: classtemplate.rst
+
+   jacobian
+   hessian
+   gradient
+
+

docs/apis/pinnx.icbc.rst

@@ -0,0 +1,50 @@
+``pinnx.icbc`` module
+=====================
+
+.. currentmodule:: pinnx.icbc 
+.. automodule:: pinnx.icbc 
+
+Base Initial and Boundary Conditions Class
+------------------------------------------
+
+.. autosummary::
+   :toctree: generated/
+   :nosignatures:
+   :template: classtemplate.rst
+
+   AbstractGeometry
+   ICBC
+   Optional
+   Dict
+
+
+Boundary Conditions
+-------------------
+
+.. autosummary::
+   :toctree: generated/
+   :nosignatures:
+   :template: classtemplate.rst
+
+   BC
+   DirichletBC
+   Interface2DBC
+   NeumannBC
+   OperatorBC
+   PeriodicBC
+   PointSetBC
+   PointSetOperatorBC
+   RobinBC
+
+
+Initial Conditions
+------------------
+
+.. autosummary::
+   :toctree: generated/
+   :nosignatures:
+   :template: classtemplate.rst
+
+   IC
+
+

docs/apis/pinnx.metrics.rst

@@ -0,0 +1,24 @@
+``pinnx.metrics`` module
+========================
+
+.. currentmodule:: pinnx.metrics
+.. automodule:: pinnx.metrics
+
+Metrics
+-------
+
+.. autosummary::
+   :toctree: generated/
+   :nosignatures:
+   :template: classtemplate.rst
+
+   accuracy
+   l2_relative_error
+   nanl2_relative_error
+   mean_l2_relative_error
+   mean_squared_error
+   mean_absolute_percentage_error
+   max_absolute_percentage_error
+   absolute_percentage_error_std
+
+

docs/apis/pinnx.nn.rst

@@ -0,0 +1,108 @@
+``pinnx.nn`` module
+===================
+
+.. currentmodule:: pinnx.nn 
+.. automodule:: pinnx.nn 
+
+Base Neural Network Class
+-------------------------
+
+.. autosummary::
+   :toctree: generated/
+   :nosignatures:
+   :template: classtemplate.rst
+
+   NN
+   Optional
+   Callable
+
+
+Dict and Array Converters
+-------------------------
+
+.. autosummary::
+   :toctree: generated/
+   :nosignatures:
+   :template: classtemplate.rst
+
+   DictToArray
+   ArrayToDict
+
+
+DeepONet Strategy
+-----------------
+
+.. autosummary::
+   :toctree: generated/
+   :nosignatures:
+   :template: classtemplate.rst
+
+   abstractmethod
+   ABC
+   DeepONetStrategy
+   SingleOutputStrategy
+   IndependentStrategy
+   SplitBothStrategy
+   SplitBranchStrategy
+   SplitTrunkStrategy
+
+
+DeepONet
+--------
+
+.. autosummary::
+   :toctree: generated/
+   :nosignatures:
+   :template: classtemplate.rst
+
+   DeepONet
+   DeepONetCartesianProd
+   PODDeepONet
+
+
+Fully Connected Neural Network
+------------------------------
+
+.. autosummary::
+   :toctree: generated/
+   :nosignatures:
+   :template: classtemplate.rst
+
+   get_activation
+   NN
+   FNN
+   PFNN
+   Union
+   Callable
+   Sequence
+   Optional
+
+
+Multiple Input Operators Network
+--------------------------------
+
+.. autosummary::
+   :toctree: generated/
+   :nosignatures:
+   :template: classtemplate.rst
+
+   get_activation
+   NN
+   FNN
+   MIONetCartesianProd
+   PODMIONet
+   Optional
+   Callable
+
+
+Model
+-----
+
+.. autosummary::
+   :toctree: generated/
+   :nosignatures:
+   :template: classtemplate.rst
+
+   Model
+
+