Restructuring Sphinx docs.

bjmorgan · Jul 7, 2021 · 06f2800 · 06f2800
1 parent c8b083a
commit 06f2800
Show file tree

Hide file tree

Showing 12 changed files with 89 additions and 81 deletions.
diff --git a/docs/source/pyscses.calculation.rst b/docs/source/pyscses.calculation.rst
@@ -0,0 +1,7 @@
+pyscses.calculation module
+==========================
+
+.. automodule:: pyscses.calculation
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/pyscses.constants.rst b/docs/source/pyscses.constants.rst
@@ -0,0 +1,8 @@
+pyscses.constants module
+========================
+
+.. automodule:: pyscses.constants
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
diff --git a/docs/source/pyscses.defect_at_site.rst b/docs/source/pyscses.defect_at_site.rst
@@ -0,0 +1,7 @@
+pyscses.defect\_at\_site module
+-------------------------------
+
+.. automodule:: pyscses.defect_at_site
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/pyscses.defect_species.rst b/docs/source/pyscses.defect_species.rst
@@ -0,0 +1,7 @@
+pyscses.defect\_species module
+==============================
+
+.. automodule:: pyscses.defect_species
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/pyscses.grid.rst b/docs/source/pyscses.grid.rst
@@ -0,0 +1,8 @@
+pyscses.grid module
+===================
+
+.. automodule:: pyscses.grid
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
diff --git a/docs/source/pyscses.grid_point.rst b/docs/source/pyscses.grid_point.rst
@@ -0,0 +1,8 @@
+pyscses.grid\_point module
+==========================
+
+.. automodule:: pyscses.grid_point
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
diff --git a/docs/source/pyscses.matrix_solver.rst b/docs/source/pyscses.matrix_solver.rst
@@ -0,0 +1,8 @@
+pyscses.matrix\_solver module
+=============================
+
+.. automodule:: pyscses.matrix_solver
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
diff --git a/docs/source/pyscses.rst b/docs/source/pyscses.rst
@@ -4,83 +4,15 @@ pyscses package
 Submodules
 ----------
 
-pyscses.calculation module
---------------------------
-
-.. automodule:: pyscses.calculation
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-pyscses.constants module
-------------------------
-
-.. automodule:: pyscses.constants
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-pyscses.defect\_at\_site module
--------------------------------
-
-.. automodule:: pyscses.defect_at_site
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-pyscses.defect\_species module
-------------------------------
-
-.. automodule:: pyscses.defect_species
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-pyscses.grid module
--------------------
-
-.. automodule:: pyscses.grid
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-pyscses.matrix\_solver module
------------------------------
-
-.. automodule:: pyscses.matrix_solver
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-pyscses.set\_of\_sites module
------------------------------
-
-.. automodule:: pyscses.set_of_sites
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-pyscses.set\_up\_calculation module
------------------------------------
-
-.. automodule:: pyscses.set_up_calculation
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-pyscses.site module
--------------------
-
-.. automodule:: pyscses.site
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-
-Module contents
----------------
-
-.. automodule:: pyscses
-    :members:
-    :undoc-members:
-    :show-inheritance:
+.. toctree::
+
+   pyscses.calculation
+   pyscses.constants
+   pyscses.defect_at_site
+   pyscses.defect_species
+   pyscses.grid
+   pyscses.grid_point
+   pyscses.matrix_solver
+   pyscses.set_of_sites
+   pyscses.set_up_calculation
+   pyscses.site
diff --git a/docs/source/pyscses.set_of_sites.rst b/docs/source/pyscses.set_of_sites.rst
@@ -0,0 +1,8 @@
+pyscses.set\_of\_sites module
+=============================
+
+.. automodule:: pyscses.set_of_sites
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
diff --git a/docs/source/pyscses.set_up_calculation.rst b/docs/source/pyscses.set_up_calculation.rst
@@ -0,0 +1,7 @@
+pyscses.set\_up\_calculation module
+-----------------------------------
+
+.. automodule:: pyscses.set_up_calculation
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/pyscses.site.rst b/docs/source/pyscses.site.rst
@@ -0,0 +1,8 @@
+pyscses.site module
+===================
+
+.. automodule:: pyscses.site
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
diff --git a/docs/source/readme.rst b/docs/source/readme.rst
@@ -39,7 +39,7 @@ Tests
 
 Jupyter notebooks that can be used to check the output of the calculations can be found in::
 
-pyscses/tests/test_notebooks
+    pyscses/tests/test_notebooks
 
 The test notebooks can be found on github `here <https://github.com/bjmorgan/pyscses/tree/master/tests/test_notebooks>`__.