Documentation: Fixed Broken documentation

pyxem · Apr 17, 2024 · 66f0133 · 66f0133
1 parent 3567308
commit 66f0133
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 0 deletions.
diff --git a/diffsims/generators/simulation_generator.py b/diffsims/generators/simulation_generator.py
@@ -16,6 +16,8 @@
 # You should have received a copy of the GNU General Public License
 # along with diffsims.  If not, see <http://www.gnu.org/licenses/>.
 
+"""Kinematic Diffraction Simulation Generator."""
+
 from typing import Union, Sequence
 import numpy as np
 
@@ -51,6 +53,8 @@
 
 from diffsims.simulations import Simulation1D, Simulation2D
 
+__all__ = ["SimulationGenerator"]
+
 
 class SimulationGenerator:
     """

diff --git a/diffsims/simulations/__init__.py b/diffsims/simulations/__init__.py
@@ -16,6 +16,8 @@
 # You should have received a copy of the GNU General Public License
 # along with diffsims.  If not, see <http://www.gnu.org/licenses/>.
 
+"""Kinematic Diffraction Simulation Results."""
+
 from diffsims.simulations.simulation2d import Simulation2D
 from diffsims.simulations.simulation1d import Simulation1D
 

diff --git a/diffsims/simulations/simulation2d.py b/diffsims/simulations/simulation2d.py
@@ -33,6 +33,11 @@
 if TYPE_CHECKING:  # pragma: no cover
     from diffsims.generators.simulation_generator import SimulationGenerator
 
+__all__ = [
+    "Simulation2D",
+    "get_closest",
+]
+
 
 class PhaseGetter:
     """A class for getting the phases of a simulation library.

diff --git a/doc/reference/index.rst b/doc/reference/index.rst
@@ -29,5 +29,6 @@ the `demos <https://github.com/pyxem/diffsims-demos>`_.
     libraries
     pattern
     sims
+    simulations
     structure_factor
     utils