Add PostProcessing and logger files to API documentation

CastillonMiguel · Dec 12, 2024 · 0263ece · 0263ece
1 parent 53ea050
commit 0263ece
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 1 deletion.
diff --git a/docs/source/api/Logger/main.rst b/docs/source/api/Logger/main.rst
@@ -0,0 +1,7 @@
+Logger
+======
+
+.. automodule:: phasefieldx.Logger.library_versions
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/api/PostProcessing/main.rst b/docs/source/api/PostProcessing/main.rst
@@ -0,0 +1,20 @@
+Post Processing
+===============
+
+Reference result
+----------------
+
+.. automodule:: phasefieldx.PostProcessing.ReferenceResult
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+
+Paraview
+--------
+
+.. automodule:: phasefieldx.PostProcessing.paraview
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/api/index.rst b/docs/source/api/index.rst
@@ -10,8 +10,10 @@ Welcome to the API Reference chapter of our documentation! This section provides
    Errors/main
    Norms/main
    Boundary/main
+   Element/main
    Loading/main
+   Logger/main
    Materials/main
    Math/main
+   PostProcessing/main
    Solvers/main
-   Element/main