Skip to content

Commit

Permalink
Automodapi updates
Browse files Browse the repository at this point in the history
  • Loading branch information
lukelbd committed Sep 16, 2019
1 parent 4d8f89f commit e983348
Show file tree
Hide file tree
Showing 7 changed files with 19 additions and 135 deletions.
9 changes: 4 additions & 5 deletions docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -13,18 +13,17 @@ BUILDDIR = _build

# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS)

# Make make clean ignore .git folder
# The -f doesn't raise error when files/folders not found
clean:
rm -f api/*
rm -f _autosummary/*
rm -rf api/*
rm -rf "$(BUILDDIR)"/html/*
rm -rf "$(BUILDDIR)"/doctrees/*

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
# "make mode" option. See: https://github.com/sphinx-doc/sphinx/issues/6603
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS)

12 changes: 0 additions & 12 deletions docs/_templates/autosummary/base.rst

This file was deleted.

62 changes: 0 additions & 62 deletions docs/_templates/autosummary/class.rst

This file was deleted.

43 changes: 0 additions & 43 deletions docs/_templates/autosummary/module.rst

This file was deleted.

2 changes: 2 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,8 @@ Here are some highlights of the remaining features:

To get started, check out the :ref:`Introduction`.

.. :hidden: means do not put a table of links right here but include links in sidebar
.. _MIT: LICENSE.txt

.. toctree::
Expand Down
12 changes: 6 additions & 6 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Install shinx extensions
# NOTE: The automodapi module imports module, so the website 'build' process
# has same requirements as module itself! The version choices are somewhat random.
git+https://github.com/lukelbd/sphinx-automodapi@proplot-mods
# 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@7a3d381
sphinxcontrib-bibtex>=0.4
matplotlib>=3.0
ipython>=7.0.0
numpy>=1.14
lxml>=4.0.0
ipython>=7.0.0
matplotlib>=3.0
14 changes: 7 additions & 7 deletions proplot/axes.py
Original file line number Diff line number Diff line change
Expand Up @@ -1520,7 +1520,7 @@ def __init__(self, *args, **kwargs):
"""
See also
--------
`~proplot.subplots.subplots`
`~proplot.subplots.subplots`, `Axes`
"""
# Impose default formatter
super().__init__(*args, **kwargs)
Expand Down Expand Up @@ -2187,7 +2187,7 @@ def format(self, *,
super().format(**kwargs)

def altx(self, *args, **kwargs):
"""Alias (and more intuitive name) for `~CartesianAxes.twiny`.
"""Alias and more intuitive name for `~CartesianAxes.twiny`.
The matplotlib `~matplotlib.axes.Axes.twiny` function
generates two *x*-axes with a shared ("twin") *y*-axis."""
# Cannot wrap twiny() because we want to use CartesianAxes, not
Expand All @@ -2209,7 +2209,7 @@ def altx(self, *args, **kwargs):
return ax

def alty(self):
"""Alias (and more intuitive name) for `~CartesianAxes.twinx`.
"""Alias and more intuitive name for `~CartesianAxes.twinx`.
The matplotlib `~matplotlib.axes.Axes.twinx` function
generates two *y*-axes with a shared ("twin") *x*-axis."""
# Must reproduce twinx here because need to generate CartesianAxes
Expand Down Expand Up @@ -2363,7 +2363,7 @@ def __init__(self, *args, **kwargs):
"""
See also
--------
`~proplot.subplots.subplots`
`~proplot.subplots.subplots`, `Axes`
"""
# Set tick length to zero so azimuthal labels are not too offset
# Change default radial axis formatter but keep default theta one
Expand Down Expand Up @@ -2587,7 +2587,7 @@ def __init__(self, *args, **kwargs): # just to disable docstring inheritence
"""
See also
--------
`~proplot.subplots.subplots`, `CartopyAxes`, `BasemapAxes`
`~proplot.subplots.subplots`, `Axes`, `CartopyAxes`, `BasemapAxes`
"""
# Store props that let us dynamically and incrementally modify
# line locations and settings like with Cartesian axes
Expand Down Expand Up @@ -2816,7 +2816,7 @@ def __init__(self, *args, map_projection=None, **kwargs):
See also
--------
`~proplot.subplots.subplots`, `~proplot.projs`
`~proplot.subplots.subplots`, `Axes`, `~proplot.projs`
"""
# GeoAxes initialization. Note that critical attributes like
# outline_patch needed by _format_apply are added before it is called.
Expand Down Expand Up @@ -3105,7 +3105,7 @@ def __init__(self, *args, map_projection=None, **kwargs):
See also
--------
`~proplot.subplots.subplots`, `~proplot.projs`
`~proplot.subplots.subplots`, `Axes`, `~proplot.projs`
"""
# Map boundary notes
# * Must set boundary before-hand, otherwise the set_axes_limits method
Expand Down

0 comments on commit e983348

Please sign in to comment.