Skip to content

Validate assignments to rc configurator #109

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
lukelbd wants to merge 1 commit into from
Closed

Validate assignments to rc configurator #109

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,8 +195,17 @@
f.write(HtmlFormatter(style=style).get_style_defs('.highlight'))

# Create sample .proplotrc file
from proplot.rctools import _write_defaults # noqa: E402
_write_defaults(os.path.join('_static', 'proplotrc'), comment=False)
from proplot.rctools import _write_default_rc_file # noqa: E402
_write_default_rc_file(os.path.join('_static', 'proplotrc'), comment=False)

# Create params_long and params_short tables
from proplot.rctools import _write_default_rst_table # noqa: E402
_write_default_rst_table(
os.path.join('_static', 'rcParamsShort.rst'), cat='short', table=True
)
_write_default_rst_table(
os.path.join('_static', 'rcParamsLong.rst'), cat='short', table=True
)

# Role
# default family is py, but can also set default role so don't need
Expand Down
125 changes: 3 additions & 122 deletions docs/configuration.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,49 +41,7 @@ ProPlot settings at once, as shorthands for settings with longer names, or
for special options. For example, :rcraw:`ticklen` changes the tick length for
the *x* and *y* axes in one go.

================ ==============================================================================================================================================================================================================================================
Key Description
================ ==============================================================================================================================================================================================================================================
``abc`` Boolean, whether to draw a-b-c labels by default.
``align`` Whether to align axis labels during draw. See `aligning labels <https://matplotlib.org/3.1.1/gallery/subplots_axes_and_figures/align_labels_demo.html>`__.
``alpha`` The opacity of the background axes patch.
``autoreload`` If not empty or ``0``, passed to `%autoreload <https://ipython.readthedocs.io/en/stable/config/extensions/autoreload.html#magic-autoreload>`__.
``autosave`` If not empty or ``0``, passed to `%autosave <https://www.webucator.com/blog/2016/03/change-default-autosave-interval-in-ipython-notebook/>`__.
``borders`` Boolean, toggles country border lines on and off.
``cmap`` The default colormap.
``coast`` Boolean, toggles coastline lines on and off.
``color`` The color of axis spines, tick marks, tick labels, and labels.
``cycle`` The default color cycle name, used e.g. for lines.
``facecolor`` The color of the background axes patch.
``fontname`` Name of font used for all text in the figure. The default is Helvetica Neue. See `~proplot.fonttools` for details.
``geogrid`` Boolean, toggles meridian and parallel gridlines on and off.
``grid`` Boolean, toggles major grid lines on and off.
``gridminor`` Boolean, toggles minor grid lines on and off.
``gridratio`` Ratio of minor gridline width to major gridline width.
``inlinefmt`` The inline backend figure format or list thereof. Valid formats include ``'svg'``, ``'pdf'``, ``'retina'``, ``'png'``, and ``jpeg``.
``innerborders`` Boolean, toggles internal border lines on and off, e.g. for states and provinces.
``lakes`` Boolean, toggles lake patches on and off.
``land`` Boolean, toggles land patches on and off.
``large`` Font size for titles, "super" titles, and a-b-c subplot labels.
``linewidth`` Thickness of axes spines and major tick lines.
``lut`` The number of colors to put in the colormap lookup table.
``margin`` The margin of space between axes edges and objects plotted inside the axes, if ``xlim`` and ``ylim`` are unset.
``matplotlib`` If not empty, passed to `%matplotlib <https://ipython.readthedocs.io/en/stable/interactive/magics.html#magic-matplotlib>`__. If ``'auto'`` (the default) uses ``'inline'`` for notebooks and ``'osx'`` or ``'qt'`` for other ipython sessions.
``ocean`` Boolean, toggles ocean patches on and off.
``reso`` Resolution of geographic features, one of ``'lo'``, ``'med'``, or ``'hi'``
``rgbcycle`` If ``True``, and ``colorblind`` is the current cycle, this registers the ``colorblind`` colors as ``'r'``, ``'b'``, ``'g'``, etc., like in `seaborn <https://seaborn.pydata.org/tutorial/color_palettes.html>`__.
``rivers`` Boolean, toggles river lines on and off.
``share`` The axis sharing level, one of ``0``, ``1``, ``2``, or ``3``. See `~proplot.subplots.subplots` for details.
``small`` Font size for legend text, tick labels, axis labels, and text generated with `~matplotlib.axes.Axes.text`.
``span`` Boolean, toggles spanning axis labels. See `~proplot.subplots.subplots` for details.
``tickdir`` Major and minor tick direction. Must be one of ``out``, ``in``, or ``inout``.
``ticklen`` Length of major ticks in points.
``ticklenratio`` Ratio of minor tickline length to major tickline length.
``tickpad`` Padding between ticks and tick labels in points.
``titlepad`` Padding between the axes and the title, alias for :rcraw:`axes.titlepad`.
``tickratio`` Ratio of minor tickline width to major tickline width.
``tight`` Boolean, indicates whether to auto-adjust figure bounds and subplot spacings.
================ ==============================================================================================================================================================================================================================================
.. include:: _static/rcParamsShort.rst

rcParamsLong
------------
Expand All @@ -102,91 +60,14 @@ There are two new additions to the ``image`` category, and the new
`~proplot.axes.Axes.colorbar` properties.
The new ``gridminor`` category controls minor gridline settings,
and the new ``geogrid`` category controls meridian and parallel line settings
for `~proplot.axes.ProjAxes`. Note that when a ``grid`` property is changed,
it also changed the corresponding ``gridminor`` property.
for `~proplot.axes.ProjAxes`.

Finally, the ``geoaxes``, ``land``, ``ocean``, ``rivers``, ``lakes``,
``borders``, and ``innerborders`` categories control various
`~proplot.axes.ProjAxes` settings. These are used when the boolean
toggles for the corresponding :ref:`rcParamsShort` settings are turned on.

=============================== =========================================================================================================================================================================================================================================================
Key(s) Description
=============================== =========================================================================================================================================================================================================================================================
``abc.style`` a-b-c label style. For options, see `~proplot.axes.Axes.format`.
``abc.loc`` a-b-c label position. For options, see `~proplot.axes.Axes.format`.
``abc.border`` Boolean, indicates whether to draw a white border around a-b-c labels inside an axes.
``abc.linewidth`` Width of the white border around a-b-c labels.
``abc.color`` a-b-c label color.
``abc.size`` a-b-c label font size.
``abc.weight`` a-b-c label font weight.
``axes.formatter.zerotrim`` Boolean, indicates whether trailing decimal zeros are trimmed on tick labels.
``axes.formatter.timerotation`` Float, indicates the default *x* axis tick label rotation for datetime tick labels.
``borders.color`` Line color for country borders.
``borders.linewidth`` Line width for country borders.
``bottomlabel.color`` Font color for column labels on the bottom of the figure.
``bottomlabel.size`` Font size for column labels on the bottom of the figure.
``bottomlabel.weight`` Font weight for column labels on the bottom of the figure.
``colorbar.loc`` Inset colorbar location, options are listed in `~proplot.axes.Axes.colorbar`.
``colorbar.grid`` Boolean, indicates whether to draw borders between each level of the colorbar.
``colorbar.frameon`` Boolean, indicates whether to draw a frame behind inset colorbars.
``colorbar.framealpha`` Opacity for inset colorbar frames.
``colorbar.length`` Length of outer colorbars.
``colorbar.insetlength`` Length of inset colorbars. Units are interpreted by `~proplot.utils.units`.
``colorbar.width`` Width of outer colorbars. Units are interpreted by `~proplot.utils.units`.
``colorbar.insetwidth`` Width of inset colorbars. Units are interpreted by `~proplot.utils.units`.
``colorbar.axespad`` Padding between axes edge and inset colorbars. Units are interpreted by `~proplot.utils.units`.
``colorbar.extend`` Length of rectangular or triangular "extensions" for panel colorbars. Units are interpreted by `~proplot.utils.units`.
``colorbar.insetextend`` Length of rectangular or triangular "extensions" for inset colorbars. Units are interpreted by `~proplot.utils.units`.
``geoaxes.facecolor`` Face color for the map outline patch.
``geoaxes.edgecolor`` Edge color for the map outline patch.
``geoaxes.linewidth`` Edge width for the map outline patch.
``geogrid.labels`` Boolean, indicates whether to label the parallels and meridians.
``geogrid.labelsize`` Font size for latitude and longitude labels. Inherits from ``small``.
``geogrid.latmax`` Absolute latitude in degrees, poleward of which meridian gridlines are cut off.
``geogrid.lonstep`` Default interval for meridian gridlines in degrees.
``geogrid.latstep`` Default interval for parallel gridlines in degrees.
``gridminor.linewidth`` Minor gridline width.
``gridminor.linestyle`` Minor gridline style.
``gridminor.alpha`` Minor gridline transparency.
``gridminor.color`` Minor gridline color.
``image.levels`` Default number of levels for ``pcolormesh`` and ``contourf`` plots.
``image.edgefix`` Whether to fix the `white-lines-between-filled-contours <https://stackoverflow.com/q/8263769/4970632>`__ and `white-lines-between-pcolor-rectangles <https://stackoverflow.com/q/27092991/4970632>`__ issues. This slows down figure rendering a bit.
``innerborders.color`` Line color for internal border lines.
``innerborders.linewidth`` Line width for internal border lines.
``land.color`` Face color for land patches.
``lakes.color`` Face color for lake patches.
``leftlabel.color`` Font color for row labels on the left-hand side.
``leftlabel.size`` Font size for row labels on the left-hand side.
``leftlabel.weight`` Font weight for row labels on the left-hand side.
``ocean.color`` Face color for ocean patches.
``rightlabel.color`` Font color for row labels on the right-hand side.
``rightlabel.size`` Font size for row labels on the right-hand side.
``rightlabel.weight`` Font weight for row labels on the right-hand side.
``rivers.color`` Line color for river lines.
``rivers.linewidth`` Line width for river lines.
``subplots.axwidth`` Default width of each axes. Units are interpreted by `~proplot.utils.units`.
``subplots.panelwidth`` Width of side panels. Units are interpreted by `~proplot.utils.units`.
``subplots.pad`` Padding around figure edge. Units are interpreted by `~proplot.utils.units`.
``subplots.axpad`` Padding between adjacent subplots. Units are interpreted by `~proplot.utils.units`.
``subplots.panelpad`` Padding between subplots and panels, and between stacked panels. Units are interpreted by `~proplot.utils.units`.
``suptitle.color`` Figure title color.
``suptitle.size`` Figure title font size.
``suptitle.weight`` Figure title font weight.
``tick.color`` Axis tick label color. Mirrors the *axis* label :rcraw:`axes.labelcolor` setting.
``tick.size`` Axis tick label font size. Mirrors the *axis* label :rcraw:`axes.labelsize` setting.
``tick.weight`` Axis tick label font weight. Mirrors the *axis* label :rcraw:`axes.labelweight` setting.
``title.loc`` Title position. For options, see `~proplot.axes.Axes.format`.
``title.border`` Boolean, indicates whether to draw a white border around titles inside an axes.
``title.linewidth`` Width of the white border around titles.
``title.pad`` The title offset in arbitrary units. Alias for :rcraw:`axes.titlepad`.
``title.color`` Axes title color.
``title.size`` Axes title font size.
``title.weight`` Axes title font weight.
``toplabel.color`` Font color for column labels on the top of the figure.
``toplabel.size`` Font size for column labels on the top of the figure.
``toplabel.weight`` Font weight for column labels on the top of the figure.
=============================== =========================================================================================================================================================================================================================================================
.. include:: _static/rcParamsLong.rst

The .proplotrc file
-------------------
Expand Down
6 changes: 3 additions & 3 deletions docs/sphinxext/custom_roles.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
from docutils import nodes
from os.path import sep
from proplot import rc
from proplot.rctools import rc, rcParamsShort, rcParamsLong


def get_nodes(rawtext, text, inliner):
rctext = (f"rc['{text}']" if '.' in text else f'rc.{text}')
rctext = f"rc['{text}']" if '.' in text else f'rc.{text}'
rendered = nodes.Text(rctext)
source = inliner.document.attributes['source'].replace(sep, '/')
relsource = source.split('/docs/', 1)
Expand All @@ -13,7 +13,7 @@ def get_nodes(rawtext, text, inliner):
levels = relsource[1].count('/') # distance to 'docs' folder
refuri = (
'../' * levels
+ f'en/latest/configuration.html?highlight={text}#'
+ f'configuration.html?highlight={text}#'
+ ('rcparamslong' if '.' in text else 'rcparamsshort')
)
ref = nodes.reference(rawtext, rendered, refuri=refuri)
Expand Down
5 changes: 3 additions & 2 deletions proplot/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,10 @@
# the fontManager is loaded by other modules (requiring a rebuild)
import os as _os
import pkg_resources as _pkg
from .utils import _benchmark
from .utils import * # noqa: F401 F403
from .cbook import _benchmark
with _benchmark('total time'):
with _benchmark('utils'):
from .utils import * # noqa: F401 F403
with _benchmark('styletools'):
from .styletools import * # noqa: F401 F403
with _benchmark('rctools'):
Expand Down
Loading