Corrects documentation.

luizfelippesr · Jul 14, 2018 · ea9062d · ea9062d
1 parent cbcb3a7
commit ea9062d
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 7 deletions.
diff --git a/doc/index.rst b/doc/index.rst
@@ -15,9 +15,12 @@ A quick tour through the functionality and a description of the features and usa
 `tutorial <http://nbviewer.jupyter.org/url/www.mas.ncl.ac.uk/~nlfsr/galmag/galmag_tutorial.ipynb>`_
 jupyter notebook.
 
-Code documentation
-------------------
+
+.. toctree::
+    :maxdepth: 4
+
+    Code documentation <modules.rst>
+
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
-
diff --git a/galmag/B_field.py b/galmag/B_field.py
@@ -268,7 +268,7 @@ class B_field(object):
     `set_field_component` method. Alternatively, the custom component can be
     added during initialization as an extra keyword
     (i.e. B_field.set_field_component(name, component) is equivalent to
-     B_field(..., name=component).
+    B_field(..., name=component).
 
     Parameters
     ----------

diff --git a/galmag/disk_profiles.py b/galmag/disk_profiles.py
@@ -323,13 +323,14 @@ def regularize(r, Om, S, r_reg, Om_reg, k=4):
     applying an exponential cutoff on Omega to prevent it.
 
     .. math::
-        \Omega(r) = \exp\left[-(r_\\xi/r)^k\right]\left[\tilde\Omega(r)-\Omega_\\xi\right] + \Omega_\\xi\,,
+        \Omega(r) = \exp\left[-(r_\\xi/r)^k\\right]\left[ \\tilde\Omega(r)-\Omega_\\xi\\right] + \Omega_\\xi\,,
 
     and
 
     .. math::
-        S(r) = \e^{-(r_\\xi/r)^k}\left\{k\left(\frac{r_\\xi}{r}\right)^k\left[\tilde\Omega(r)
-          -\Omega_\\xi\right] +\tilde S\right\}
+        S(r) = e^{-(r_\\xi/r)^k}\left\{k\left(\\frac{r_\\xi}{r}\\right)^k\\left[\\tilde\Omega(r)
+          -\Omega_\\xi \\right] +\\tilde S \\right\}
+
 
     Parameters
     ----------