Fixed documentation

PrincetonUniversity · Oct 10, 2024 · 6c04db9 · 6c04db9
1 parent 0cef356
commit 6c04db9
Show file tree

Hide file tree

Showing 6 changed files with 13 additions and 17 deletions.
diff --git a/docs/api/policies/chunk_element/iterator.rst b/docs/api/policies/chunk_element/iterator.rst
@@ -12,7 +12,7 @@ Chunk element iterator to generate indices for quadrature points defined by :ref
 Implementation details
 ----------------------
 
-.. doxygenclass:: specfem::iterator::chunk< ViewType, specfem::dimension::type::dim2, SIMD>
+.. doxygenclass:: specfem::iterator::chunk< ViewType, specfem::dimension::type::dim2, SIMD >
     :members:
 
 .. _iterator_chunk_element_index:
@@ -22,14 +22,14 @@ Chunk element index types
 
 Index types generated by the chunk element iterator.
 
-.. doxygenclass:: specfem::iterator::impl::chunk_index_type
+.. doxygenstruct:: specfem::iterator::impl::chunk_index_type
     :members:
 
 Implementation details
 ----------------------
 
-.. doxygenclass:: specfem::iterator::impl::chunk_index_type< true, DimensionType >
+.. doxygenstruct:: specfem::iterator::impl::chunk_index_type< true, DimensionType >
     :members:
 
-.. doxygenclass:: specfem::iterator::impl::chunk_index_type< false, DimensionType >
+.. doxygenstruct:: specfem::iterator::impl::chunk_index_type< false, DimensionType >
     :members:
diff --git a/docs/api/policies/chunk_element/policy.rst b/docs/api/policies/chunk_element/policy.rst
@@ -6,5 +6,5 @@ Chunk Element Policy
 
 Policy to chunk a range of elements into chunks assigned to Kokkos teams and iterate over quadrature points within each chunk.
 
-.. doxygenclass:: specfem::policy::element_chunk
+.. doxygenstruct:: specfem::policy::element_chunk
     :members:
diff --git a/docs/api/policies/edge/iterator.rst b/docs/api/policies/edge/iterator.rst
@@ -6,13 +6,13 @@ Edge Iterator
 
 Edge iterator to generate indices for quadrature points defined by :ref:`policy_edge` policy.
 
-.. doxygenclass:: specfem::iterator::edge
+.. doxygenstruct:: specfem::iterator::edge
     :members:
 
 Implementation details
 ----------------------
 
-.. doxygenclass:: specfem::iterator::edge< specfem::dimension::type::dim2 >
+.. doxygenstruct:: specfem::iterator::edge< specfem::dimension::type::dim2 >
     :members:
 
 .. _iterator_edge_index:
@@ -22,5 +22,5 @@ Edge index types
 
 Index types generated by the edge iterator.
 
-.. doxygenclass:: specfem::iterator::impl::edge_index_type
+.. doxygenstruct:: specfem::iterator::impl::edge_index_type
     :members:
diff --git a/docs/api/policies/edge/policy.rst b/docs/api/policies/edge/policy.rst
@@ -6,5 +6,5 @@ Edge Policy
 
 Policy to iterator over shared edges between elements in a mesh.
 
-.. doxygenclass:: specfem::policy::element_edge
+.. doxygenstruct:: specfem::policy::element_edge
     :members:
diff --git a/docs/developer_documentation/tutorials/tutorial1/Chapter9/index.rst b/docs/developer_documentation/tutorials/tutorial1/Chapter9/index.rst
@@ -38,20 +38,16 @@ The time-scheme is divided into 2 phases: 1. Predictor phase and 2. Corrector ph
 .. math::
 
     \begin{align*}
-    u^{n+1} &= u^n + \Delta t v^n + \frac{1}{2} \Delta t^2 a^n
-
-    v^{n+1} &= v^n + \frac{1}{2} \Delta t a^n
-
+    u^{n+1} &= u^n + \Delta t v^n + \frac{1}{2} \Delta t^2 a^n \\
+    v^{n+1} &= v^n + \frac{1}{2} \Delta t a^n \\
     M u^{n+1} + C v^{n+1} + K u^{n+1} &= F^{n+1}
     \end{align*}
 
 Here, the 3rd equation is the discretized form of the equation of motion solved by the spectral element method. The corrector phase is given by:
 
 .. math::
 
-    \begin{align*}
-    v^{n} &= v^n + \frac{1}{2} \Delta t a^{n+1}
-    \end{align*}
+    v^{n} = v^n + \frac{1}{2} \Delta t a^{n+1}
 
 Implemeting the Time Scheme
 ---------------------------

diff --git a/docs/developer_documentation/tutorials/tutorial2/Chapter2/index.rst b/docs/developer_documentation/tutorials/tutorial2/Chapter2/index.rst
@@ -59,4 +59,4 @@ The writer class is templated on the output library. Since, all the IO libraries
 SPECFEM++ Implementation Details
 --------------------------------
 
-The actual SPECFEM++ implementation details can be found :ref:`here <IO_write_wavefield>`.
+The actual SPECFEM++ implementation details can be found :ref:`here <IO_writer_wavefield>`.