use sphinx.ext.extlinks for DOI links

aburrell · Nov 26, 2015 · 6022a1e · 6022a1e
1 parent a9d0cd5
commit 6022a1e
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 12 deletions.
diff --git a/AUTHORS.rst b/AUTHORS.rst
@@ -14,12 +14,12 @@ IGRF-12 with coefficients valid through 2020 [Thébault et al., 2015] [3]_.
 .. [1] Emmert, J. T., A. D. Richmond, and D. P. Drob (2010),
        A computationally compact representation of Magnetic-Apex
        and Quasi-Dipole coordinates with smooth base vectors,
-       J. Geophys. Res., 115(A8), A08322, doi:10.1029/2010JA015326.
+       J. Geophys. Res., 115(A8), A08322, :doi:`10.1029/2010JA015326`.
 
 .. [2] Richmond, A. D. (1995), Ionospheric Electrodynamics Using
        Magnetic Apex Coordinates, Journal of geomagnetism and
-       geoelectricity, 47(2), 191–212, doi:10.5636/jgg.47.191.
+       geoelectricity, 47(2), 191–212, :doi:`10.5636/jgg.47.191`.
 
 .. [3] Thébault, E. et al. (2015), International Geomagnetic Reference
        Field: the 12th generation, Earth, Planets and Space, 67(1), 79,
-       doi:10.1186/s40623-015-0228-9.
+       :doi:`10.1186/s40623-015-0228-9`.
diff --git a/README.rst b/README.rst
@@ -54,11 +54,11 @@ References
 .. [1] Emmert, J. T., A. D. Richmond, and D. P. Drob (2010),
        A computationally compact representation of Magnetic-Apex
        and Quasi-Dipole coordinates with smooth base vectors,
-       J. Geophys. Res., 115(A8), A08322, doi:10.1029/2010JA015326.
+       J. Geophys. Res., 115(A8), A08322, :doi:`10.1029/2010JA015326`.
 
 .. [2] Richmond, A. D. (1995), Ionospheric Electrodynamics Using
        Magnetic Apex Coordinates, Journal of geomagnetism and
-       geoelectricity, 47(2), 191–212, doi:10.5636/jgg.47.191.
+       geoelectricity, 47(2), 191–212, :doi:`10.5636/jgg.47.191`.
 
 Badges
 ======

diff --git a/docs/conf.py b/docs/conf.py
@@ -8,7 +8,8 @@
     'sphinx.ext.autodoc',
     'sphinx.ext.autosummary',
     'sphinx.ext.viewcode',
-    'sphinx.ext.napoleon'
+    'sphinx.ext.napoleon',
+    'sphinx.ext.extlinks'
 ]
 if os.getenv('SPELLCHECK'):
     extensions += 'sphinxcontrib.spelling',
@@ -42,3 +43,5 @@
 autodoc_member_order='bysource'
 napoleon_use_ivar=True
 napoleon_use_rtype=False
+
+extlinks = {'doi': ('http://dx.doi.org/%s', 'doi:')}
diff --git a/docs/reference/fortranapex.rst b/docs/reference/fortranapex.rst
@@ -6,4 +6,4 @@ This module is the interface to the apex Fortran library by Emmert et al. [2010]
 .. [1] Emmert, J. T., A. D. Richmond, and D. P. Drob (2010),
        A computationally compact representation of Magnetic-Apex
        and Quasi-Dipole coordinates with smooth base vectors,
-       J. Geophys. Res., 115(A8), A08322, doi:10.1029/2010JA015326.
+       J. Geophys. Res., 115(A8), A08322, :doi:`10.1029/2010JA015326`.
diff --git a/src/apexpy/apex.py b/src/apexpy/apex.py
@@ -56,7 +56,7 @@ class Apex(object):
 
     .. [1] Thébault, E. et al. (2015), International Geomagnetic Reference
            Field: the 12th generation, Earth, Planets and Space, 67(1), 79,
-           doi:10.1186/s40623-015-0228-9.
+           :doi:`10.1186/s40623-015-0228-9`.
 
     '''
 
@@ -671,12 +671,12 @@ def basevectors_qd(self, lat, lon, height, coords='geo', precision=1e-10):
         ==========
         .. [2] Richmond, A. D. (1995), Ionospheric Electrodynamics Using
                Magnetic Apex Coordinates, Journal of geomagnetism and
-               geoelectricity, 47(2), 191–212, doi:10.5636/jgg.47.191.
+               geoelectricity, 47(2), 191–212, :doi:`10.5636/jgg.47.191`.
 
         .. [3] Emmert, J. T., A. D. Richmond, and D. P. Drob (2010),
                A computationally compact representation of Magnetic-Apex
                and Quasi-Dipole coordinates with smooth base vectors,
-               J. Geophys. Res., 115(A8), A08322, doi:10.1029/2010JA015326.
+               J. Geophys. Res., 115(A8), A08322, :doi:`10.1029/2010JA015326`.
 
         '''
 
@@ -744,12 +744,12 @@ def basevectors_apex(self, lat, lon, height, coords='geo', precision=1e-10):
 
         .. [4] Richmond, A. D. (1995), Ionospheric Electrodynamics Using
                Magnetic Apex Coordinates, Journal of geomagnetism and
-               geoelectricity, 47(2), 191–212, doi:10.5636/jgg.47.191.
+               geoelectricity, 47(2), 191–212, :doi:`10.5636/jgg.47.191`.
 
         .. [5] Emmert, J. T., A. D. Richmond, and D. P. Drob (2010),
                A computationally compact representation of Magnetic-Apex
                and Quasi-Dipole coordinates with smooth base vectors,
-               J. Geophys. Res., 115(A8), A08322, doi:10.1029/2010JA015326.
+               J. Geophys. Res., 115(A8), A08322, :doi:`10.1029/2010JA015326`.
 
         '''