Repository: PlasmaPy/PlasmaPy

Issue:
Add documentation build as part of testing?
It looks like PlasmaPy doesn't build docs as part of the continuous integration testing. Usually it's a good idea to build the docs to make sure any changes made in PRs don't stop the documentation building.

If there's interest in this I'm happy to take a stab at it. Options are using another travis build slot, or using another CI provider (a couple of projects I contribute to use https://circleci.com/)


Discussion:
YES

I was wondering how to approach doing that! It would be really great if you could do it, if it's not much of a problem for you.

I don't know which way to do this is optimal. Travis is nice, but perhaps having two Travis builds may be confusing? Do you think it would be a better move to run CircleCI or something else?

You're the expert here, so I'd appreciate any advice!

Resolving patch:
diff --git a/docs/conf.py b/docs/conf.py
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -106,7 +106,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+# html_static_path = ['_static']
 
 
 # -- Options for HTMLHelp output ------------------------------------------
diff --git a/plasmapy/mathematics/mathematics.py b/plasmapy/mathematics/mathematics.py
--- a/plasmapy/mathematics/mathematics.py
+++ b/plasmapy/mathematics/mathematics.py
@@ -6,7 +6,8 @@
 
 
 def plasma_dispersion_func(zeta):
-    r"""Calculate the plasma dispersion function
+    r"""
+    Calculate the plasma dispersion function
 
     Parameters
     ----------
@@ -38,7 +39,7 @@ def plasma_dispersion_func(zeta):
     .. math::
         Z(\zeta) = \pi^{-0.5} \int_{-\infty}^{+\infty} \frac{e^{-x^2}}{x-\zeta} dx
 
-    where the argument is a complex number [fried.conte-1961].
+    where the argument is a complex number [fried.conte-1961]_.
 
     In plasma wave theory, the plasma dispersion function appears
     frequently when the background medium has a Maxwellian
@@ -47,10 +48,9 @@ def plasma_dispersion_func(zeta):
 
     References
     ----------
-    .. [fried.conte-1961]
-    Fried, Burton D. and Samuel D. Conte. 1961. The Plasma Dispersion
-    Function: The Hilbert Transformation of the Gaussian. Academic
-    Press (New York and London).
+    .. [fried.conte-1961] Fried, Burton D. and Samuel D. Conte. 1961.
+       The Plasma Dispersion Function: The Hilbert Transformation of the
+       Gaussian. Academic Press (New York and London).
 
     Examples
     --------
@@ -117,14 +117,7 @@ def plasma_dispersion_func_deriv(zeta):
     .. math::
         Z'(\zeta) = \pi^{-0.5} \int_{-\infty}^{+\infty} \frac{e^{-x^2}}{(x-\zeta)^2} dx
 
-    where the argument is a complex number [fried.conte-1961].
-
-    References
-    ----------
-    .. [fried.conte-1961]
-    Fried, Burton D. and Samuel D. Conte. 1961. The Plasma Dispersion
-    Function: The Hilbert Transformation of the Gaussian. Academic
-    Press (New York and London).
+    where the argument is a complex number [fried.conte-1961]_.
 
     Examples
     --------
diff --git a/plasmapy/physics/transport.py b/plasmapy/physics/transport.py
--- a/plasmapy/physics/transport.py
+++ b/plasmapy/physics/transport.py
@@ -64,7 +64,7 @@ def Coulomb_logarithm(T, n_e, particles, V=None):
         \ln{\Lambda} \equiv \ln\left( \frac{b_{max}}{b_{min}} \right)
 
     where :math:`b_{min}` and :math:`b_{max}` are the inner and outer
-    impact parameters for Coulomb collisions _[1].
+    impact parameters for Coulomb collisions [1]_.
 
     The outer impact parameter is given by the Debye length:
     :math:`b_{min} = \lambda_D` which is a function of electron
@@ -81,7 +81,7 @@ def Coulomb_logarithm(T, n_e, particles, V=None):
     relative velocity between collisions.  This function uses the
     standard practice of choosing the inner impact parameter to be the
     maximum of these two possibilities.  Some inconsistencies exist in
-    the literature on how to define the inner impact parameter _[2].
+    the literature on how to define the inner impact parameter [2]_.
 
     Errors associated with the Coulomb logarithm are of order its
     inverse If the Coulomb logarithm is of order unity, then the
@@ -104,9 +104,9 @@ def Coulomb_logarithm(T, n_e, particles, V=None):
     .. [1] Physics of Fully Ionized Gases, L. Spitzer (1962)
 
     .. [2] Comparison of Coulomb Collision Rates in the Plasma Physics
-    and Magnetically Confined Fusion Literature, W. Fundamenski and
-    O.E. Garcia, EFDA–JET–R(07)01
-    (http://www.euro-fusionscipub.org/wp-content/uploads/2014/11/EFDR07001.pdf)
+       and Magnetically Confined Fusion Literature, W. Fundamenski and
+       O.E. Garcia, EFDA–JET–R(07)01
+       (http://www.euro-fusionscipub.org/wp-content/uploads/2014/11/EFDR07001.pdf)
 
     """
 


Test patch: