Skip to content

.proplotrc changes and related improvements #101

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

Merged
lukelbd merged 13 commits into from
Jan 8, 2020
Merged

.proplotrc changes and related improvements #101

Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
e2f1776
Remove YAML dependency, add _update_from_file func
lukelbd Jan 8, 2020
bda6288
Use _write_defaults to generate user/docs proplotrc
lukelbd Jan 8, 2020
da7ee4d
Remove outdated nbsetup reference
lukelbd Jan 8, 2020
93853d5
Misc cleanup and rename global vars
lukelbd Jan 8, 2020
dafb319
Ignore auto-generated proplotrc
lukelbd Jan 8, 2020
152341d
Add geoaxes.facealpha as alpha child, like facecolor
lukelbd Jan 8, 2020
d9c5a61
Update configuration docs
lukelbd Jan 8, 2020
ac6eab9
Update axes.py, gridminor props can no longer be None
lukelbd Jan 8, 2020
e435832
Update axes.py, _rc_nodots rename
lukelbd Jan 8, 2020
ebd0f26
Correct sphinx docstring bugs
lukelbd Jan 8, 2020
b2d57fd
Handle cmap/cycle FileNotFound inside _from_file
lukelbd Jan 8, 2020
7ee4a19
Update changelog
lukelbd Jan 8, 2020
2b2717b
Fix format() bug where short params not in _rc_nodots
lukelbd Jan 8, 2020
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
Prev Previous commit
Next Next commit
Update configuration docs
  • Loading branch information
@lukelbd
lukelbd committed Jan 8, 2020
commit d9c5a61045a754b40b1c3b99b11d1d7e6b9e191c
20 changes: 9 additions & 11 deletions docs/configuration.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,23 +7,23 @@ Overview
A special object named `~proplot.rctools.rc`, belonging to the
`~proplot.rctools.rc_configurator` class, is created on import.
This is your one-stop shop for changing global settings belonging to any of
the following three categories.
the following three categories:

1. Builtin matplotlib `rcParams <https://matplotlib.org/users/customizing.html>`__
settings. These have the format ``x.y`` or ``x.y.z``.
2. ProPlot :ref:`rcParamsLong` settings. These also have the format ``x.y``
(see below).
3. ProPlot :ref:`rcParamsShort` settings. These have no dots (see below).

You can change settings with the `~proplot.rctools.rc` object as follows.
You can change settings with the `~proplot.rctools.rc` object as follows:

* ``plot.rc.name = value``
* ``plot.rc['name'] = value``
* ``plot.rc.update(name1=value1, name2=value2)``
* ``plot.rc.update({'name1':value1, 'name2':value2})``

To temporarily change settings on a particular axes, use either of the
following.
following:

* ``ax.format(name=value)``
* ``ax.format(rc_kw={'name':value})``
Expand Down Expand Up @@ -102,8 +102,8 @@ 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`. For both ``gridminor`` and ``geogrid``, if
a property is empty, the corresponding property from ``grid`` is used.
for `~proplot.axes.ProjAxes`. Note that when a ``grid`` property is changed,
it also changed the corresponding ``gridminor`` property.

Finally, the ``geoaxes``, ``land``, ``ocean``, ``rivers``, ``lakes``,
``borders``, and ``innerborders`` categories control various
Expand Down Expand Up @@ -195,11 +195,9 @@ To modify the global settings, edit your
``~/.proplotrc`` file. To modify settings for a particular project,
create a ``.proplotrc`` file in the same directory as your ipython
notebook, or in an arbitrary parent directory.
As an example, a ``.proplotrc`` file containing the default settings
is shown below. The syntax is mostly the same as the syntax used for
`matplotlibrc files <https://matplotlib.org/3.1.1/tutorials/introductory/customizing.html#customizing-with-matplotlibrc-files>`__.

As an example, the default ``.proplotrc`` file
is shown below. The syntax is roughly the same as that used for
``matplotlibrc`` files, although ``.proplotrc`` strictly adheres to
`YAML <https://en.wikipedia.org/wiki/YAML>`__.

.. include:: ../proplot/.proplotrc
.. include:: _static/proplotrc
:literal: