added rsts for all src files

0b2ed23c · jannick.wolters · a983b3e2 · 0b2ed23c · 0b2ed23c · 0b2ed23c
Commit 0b2ed23c authored Jan 16, 2021 by jannick.wolters
--- a/doc/common/index.rst
+++ b/doc/common/index.rst
 Common
 ======

-TODO
-
 .. toctree::
   :maxdepth: 1


--- a/doc/entropies/entropybase.rst
+++ b/doc/entropies/entropybase.rst
+EntropyBase
+===========
+
+.. doxygenclass:: EntropyBase
+   :members:
--- a/doc/entropies/index.rst
+++ b/doc/entropies/index.rst
 Entropies
 =========

-TODO
-
 .. toctree::
-   :maxdepth: 1
\ No newline at end of file
+   :maxdepth: 1
+
+   entropybase
+   maxwellboltzmannentropy
+   quadraticentropy
\ No newline at end of file
--- a/doc/entropies/maxwellboltzmannentropy.rst
+++ b/doc/entropies/maxwellboltzmannentropy.rst
+MaxwellBoltzmannEntropy
+=======================
+
+.. doxygenclass:: MaxwellBoltzmannEntropy
+   :members:
--- a/doc/entropies/quadraticentropy.rst
+++ b/doc/entropies/quadraticentropy.rst
+QuadraticEntropy
+================
+
+.. doxygenclass:: QuadraticEntropy
+   :members:
--- a/doc/fluxes/index.rst
+++ b/doc/fluxes/index.rst
 Fluxes
 ======

-TODO
-
 .. toctree::
-   :maxdepth: 1
\ No newline at end of file
+   :maxdepth: 1
+
+   numericalflux
+   laxfriedrichsflux
+   upwindflux
\ No newline at end of file
--- a/doc/fluxes/laxfriedrichsflux.rst
+++ b/doc/fluxes/laxfriedrichsflux.rst
+LaxFriedrichsFlux
+=================
+
+.. doxygenclass:: LaxFriedrichsFlux
+   :members:
--- a/doc/fluxes/numericalflux.rst
+++ b/doc/fluxes/numericalflux.rst
+NumericalFlux
+=============
+
+.. doxygenclass:: NumericalFlux
+   :members:
--- a/doc/fluxes/upwindflux.rst
+++ b/doc/fluxes/upwindflux.rst
+UpwindFlux
+==========
+
+.. doxygenclass:: UpwindFlux
+   :members:
--- a/doc/kernels/index.rst
+++ b/doc/kernels/index.rst
 Kernels
 =======

-TODO
-
 .. toctree::
-   :maxdepth: 1
\ No newline at end of file
+   :maxdepth: 1
+
+   scatteringkernel
+   isotropic
+   isotropic1D
\ No newline at end of file
--- a/doc/kernels/isotropic.rst
+++ b/doc/kernels/isotropic.rst
+Isotropic
+=========
+
+.. doxygenclass:: Isotropic
+   :members:
--- a/doc/kernels/isotropic1D.rst
+++ b/doc/kernels/isotropic1D.rst
+Isotropic1D
+===========
+
+.. doxygenclass:: Isotropic1D
+   :members:
--- a/doc/kernels/scatteringkernel.rst
+++ b/doc/kernels/scatteringkernel.rst
+ScatteringKernel
+================
+
+.. doxygenclass:: ScatteringKernel
+   :members:
--- a/doc/optimizers/index.rst
+++ b/doc/optimizers/index.rst
 Optimizers
 ==========

-TODO
-
 .. toctree::
-   :maxdepth: 1
\ No newline at end of file
+   :maxdepth: 1
+
+   optimizerbase
+   mloptimizer
+   newtonoptimizer
\ No newline at end of file
--- a/doc/optimizers/mloptimizer.rst
+++ b/doc/optimizers/mloptimizer.rst
+MLOptimizer
+===========
+
+.. doxygenclass:: MLOptimizer
+   :members:
--- a/doc/optimizers/newtonoptimizer.rst
+++ b/doc/optimizers/newtonoptimizer.rst
+NewtonOptimizer
+===============
+
+.. doxygenclass:: NewtonOptimizer
+   :members:
--- a/doc/optimizers/optimizerbase.rst
+++ b/doc/optimizers/optimizerbase.rst
+OptimizerBase
+=============
+
+.. doxygenclass:: OptimizerBase
+   :members:
--- a/doc/problems/aircavity1d.rst
+++ b/doc/problems/aircavity1d.rst
+AirCavity1D
+===========
+
+.. doxygenclass:: AirCavity1D
+   :members:
--- a/doc/problems/checkerboardpn.rst
+++ b/doc/problems/checkerboardpn.rst
+Checkerboard_PN
+===============
+
+.. doxygenclass:: Checkerboard_PN
+   :members:
--- a/doc/problems/checkerboardsn.rst
+++ b/doc/problems/checkerboardsn.rst
+Checkerboard_SN
+===============
+
+.. doxygenclass:: Checkerboard_SN
+   :members: