Remove sphinxcontrib bibtex requirement, cleanup docs

proplot-dev · Sep 16, 2019 · e2d8078 · e2d8078
1 parent d0516eb
commit e2d8078
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 33 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -42,22 +42,21 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    # 'nbsphinx',
-    'sphinx.ext.autodoc', # include documentation from docstrings
-    'sphinx.ext.doctest', # >>> examples
-    'sphinx.ext.autosectionlabel', # use :ref:`Heading` for any heading
-    'sphinx.ext.intersphinx',
-    'sphinx.ext.coverage',
-    'sphinx.ext.mathjax',
-    'sphinx.ext.viewcode',
-    'sphinx.ext.autosummary', # autosummary directive
-    'sphinx.ext.napoleon', # for NumPy style docstrings, instead of reStructred Text
-    'sphinx_automodapi.automodapi', # see: https://sphinxcontrib-bibtex.readthedocs.io/en/latest/quickstart.html
-    'sphinxcontrib.bibtex', # see: https://sphinxcontrib-bibtex.readthedocs.io/en/latest/quickstart.html
-    # 'IPython.sphinxext.ipython_directive', # for ipython highlighting
+    # 'nbsphinx', # TODO: add this! might require custom fork
+    'sphinx.ext.autodoc',           # include documentation from docstrings
+    'sphinx.ext.doctest',           # >>> examples
+    'sphinx.ext.autosectionlabel',  # use :ref:`Heading` for any heading
+    'sphinx.ext.intersphinx',       # external links
+    'sphinx.ext.mathjax',           # LaTeX style math
+    'sphinx.ext.viewcode',          # view code links
+    'sphinx.ext.autosummary',       # autosummary directive
+    'sphinx.ext.napoleon',          # for NumPy style docstrings, instead of reStructred Text
+    'sphinx_automodapi.automodapi', # my fork of the astropy extension
+    'sphinxext.custom_roles',       # local extension
     # 'IPython.sphinxext.ipython_console_highlighting',
+    # 'IPython.sphinxext.ipython_directive',  # for ipython highlighting
     # 'matplotlib.sphinxext.only_directives', # deprecated, see: https://github.com/statsmodels/statsmodels/issues/5291
-    # 'matplotlib.sphinxext.plot_directive', # see: https://matplotlib.org/sampledoc/extensions.html
+    # 'matplotlib.sphinxext.plot_directive',  # see: https://matplotlib.org/sampledoc/extensions.html
     ]
 
 extlinks = {

diff --git a/docs/refs.bib b/docs/refs.bib
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -2,8 +2,7 @@
 # WARNING: Pip install hangs onto older commits unless __version__ is changed
 # since otherwise setup.py will not think it is necessary to rebuild
 lxml>=4.0.0
-git+https://github.com/lukelbd/sphinx-automodapi@v0.4.proplot-mods
-sphinxcontrib-bibtex>=0.4
 numpy>=1.14
 ipython>=7.0.0
 matplotlib>=3.0
+git+https://github.com/lukelbd/sphinx-automodapi@v0.4.proplot-mods
diff --git a/proplot/axistools.py b/proplot/axistools.py
@@ -881,10 +881,9 @@ def inverted(self):
 #-----------------------------------------------------------------------------#
 class MercatorLatitudeScale(mscale.ScaleBase):
     r"""
-    Scales axis as with latitudes in the `Mercator projection
-    <http://en.wikipedia.org/wiki/Mercator_projection>`__. Inspired by
-    :cite:`barnes_rossby_2011`, and adapted from `this matplotlib example
-    <https://matplotlib.org/examples/api/custom_scale_example.html>`__.
+    Scales axis as with latitude in the `Mercator projection
+    <http://en.wikipedia.org/wiki/Mercator_projection>`__. Adapted from `this
+    example <https://matplotlib.org/examples/api/custom_scale_example.html>`__.
 
     The scale function is as follows.