proplot-dev · lukelbd · Jan 6, 2020 · Jan 3, 2020 · Jan 3, 2020 · Jan 3, 2020
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -15,7 +15,7 @@ ProPlot v1.0.0 (2020-##-##)
 This will be published when some major refactoring tasks are completed.
 See :pr:`45`, :pr:`46`, and :pr:`50`.
 
-ProPlot v0.4.0 (2020-01-##)
+ProPlot v0.4.0 (2020-##-##)
 ===========================
 .. rubric:: Deprecated
 
@@ -60,6 +60,18 @@ ProPlot v0.4.0 (2020-01-##)
   with a default ``.proplotrc`` file, change the auto-generated user ``.proplotrc``
   (:pr:`50`).
 
+ProPlot v0.3.2 (2020-##-##)
+===========================
+.. rubric:: Bug fixes
+
+- Fix `~proplot.rctools.rc_configurator.context` bug (:issue:`80` and :pr:`91`).
+- Improvements to fonts API.
+
+.. rubric:: Documentation
+
+- Imperative mood for docstring summaries (:pr:`92`).
+
+
 ProPlot v0.3.1 (2019-12-16)
 ===========================
 .. rubric:: Bug fixes

diff --git a/docs/_templates/breadcrumbs.html b/docs/_templates/breadcrumbs.html
@@ -5,10 +5,12 @@
   Name class btn-neutral so it inherits properties of other RTD buttons
 -->
 {% block breadcrumbs %}
+  <!--
   <div class="admonition note">
-    <p><a href="https://github.com/lukelbd">ProPlot author here</a>: Due to my day job as a graduate student, further development may be restricted to bugfixes until the summer of 2020. In the meantime, if you are interested in contributing to ProPlot, please see the <a href="https://proplot.readthedocs.io/en/latest/contributions.html">contribution guide</a>. Any amount of help is welcome!
+    <p><a href="https://github.com/lukelbd">ProPlot author here</a>: Due to my day job as a graduate student, certain <a href="https://github.com/lukelbd/proplot/pulls?q=is%3Aopen+is%3Apr">feature additions</a> may be delayed to the summer of 2020. In the meantime, if you are interested in contributing to ProPlot, please see the <a href="https://proplot.readthedocs.io/en/latest/contributions.html">contribution guide</a>. Any amount of help is welcome!
     </p>
   </div>
+  -->
   <li id="lightdark-li">
     <label for="lightdark-checkbox" id="lightdark-label">
       <input type="checkbox" id="lightdark-checkbox"/>

diff --git a/docs/colors_fonts.ipynb b/docs/colors_fonts.ipynb
@@ -13,14 +13,14 @@
     "raw_mimetype": "text/restructuredtext"
    },
    "source": [
-    "ProPlot registers several new color names and font families. These are described below."
+    "ProPlot registers several new color names and font families, and includes tools for defining your own color names and adding your own font families. These features are described below."
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Included color names"
+    "## Included colors"
    ]
   },
   {
@@ -48,7 +48,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Drawing from cmaps and cycles"
+    "## Colors from colormaps"
    ]
   },
   {
@@ -57,7 +57,7 @@
     "raw_mimetype": "text/restructuredtext"
    },
    "source": [
-    "If you want to draw an individual color from a smooth colormap or a color cycle, use ``color=(cmap, coord)`` or ``color=(cycle, index)`` with any command that accepts the `color` keyword. The ``coord`` should be between ``0`` and ``1``, while the ``index`` is the index on the list of cycle colors. This feature is powered by the `~proplot.styletools.ColorDict` class. This is useful if you spot a nice color in one of the available colormaps and want to use it for some arbitrary plot element."
+    "If you want to draw an individual color from a colormap or a color cycle, use ``color=(cmap, coord)`` or ``color=(cycle, index)`` with any command that accepts the `color` keyword. The ``coord`` should be between ``0`` and ``1``, while the ``index`` is the index on the list of cycle colors. This feature is powered by the `~proplot.styletools.ColorDict` class. This is useful if you spot a nice color in one of the available colormaps and want to use it for some arbitrary plot element."
    ]
   },
   {
@@ -97,7 +97,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Included font names"
+    "## Using your own colors"
    ]
   },
   {
@@ -106,9 +106,25 @@
     "raw_mimetype": "text/restructuredtext"
    },
    "source": [
-    "ProPlot adds several open source sans-serif fonts, introduces a `~proplot.styletools.show_fonts` command to display the available sans-serif fonts on your system, and tries to make the default font *Helvetica Neue*, *Helvetica*, or *Arial* if they are installed. Generally speaking, simple, clean sans-serif fonts are more appropriate for figures than serif fonts.\n",
+    "You can register your own colors by adding ``.txt`` files to the ``~/.proplot/colors`` directory and calling `~proplot.styletools.register_colors`. This command is also called on import. Each file should contain lines that look like ``color: #xxyyzz`` where ``color`` is the registered color name and ``#xxyyzz`` is the HEX color value."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Included fonts"
+   ]
+  },
+  {
+   "cell_type": "raw",
+   "metadata": {
+    "raw_mimetype": "text/restructuredtext"
+   },
+   "source": [
+    "ProPlot adds several open source sans-serif fonts and introduces a `~proplot.styletools.show_fonts` command to display the available sans-serif fonts on your system (see `~matplotlib.font_manager`). Generally speaking, simple, clean sans-serif fonts are more appropriate for figures than serif fonts.\n",
     "\n",
-    "You can register your own fonts by adding ``.ttf`` and ``.otf`` files to the ``~/.proplot/fonts`` directory and calling `~proplot.styletools.register_fonts` (which is also called on import). To change the default font, use the `~proplot.rctools.rc` object or modify your ``~/.proplotrc``. See :ref:`Configuring proplot` for details."
+    "ProPlot also changes the default font to the Helvetica-lookalike TeX Gyre Heros. Matplotlib uses DejaVu Sans by default because DejaVu Sans is open source, can be *included* in the matplotlib distribution, and includes glyphs for a wider range of mathematical characters (where you see the \"¤\" dummy symbol in the below table, that character is unavailable). However Helvetica and Arial are much more mature and (in this developer's humble opinion) aesthetically pleasing. Thus, while ProPlot prioritizes aesthetics, you may need to switch to a font with more math characters like DejaVu Sans or Fira Math."
    ]
   },
   {
@@ -118,7 +134,27 @@
    "outputs": [],
    "source": [
     "import proplot as plot\n",
-    "f = plot.show_fonts()"
+    "f = plot.show_fonts('DejaVu Sans', 'Fira Math', 'Helvetica', 'TeX Gyre Heros')"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Using your own fonts"
+   ]
+  },
+  {
+   "cell_type": "raw",
+   "metadata": {
+    "raw_mimetype": "text/restructuredtext"
+   },
+   "source": [
+    "You can register your own fonts by adding files to the ``~/.proplot/fonts`` directory and calling `~proplot.styletools.register_fonts`. This command is also called on import. To change the default font, use the `~proplot.rctools.rc` object or modify your ``~/.proplotrc``.See :ref:`Configuring proplot` for details.\n",
+    "\n",
+    "Sometimes the font you would like to use *is* installed, but the font file is not stored under the matplotlib-compatible ``.ttf``, ``.otf``, or ``.afm`` formats. For example, several macOS fonts are unavailable because they are stored as ``.dfont`` collections. Also, while matplotlib nominally supports ``.ttc`` collections, ProPlot manually removes them because figures with ``.ttc`` fonts `cannot be saved as PDFs <https://github.com/matplotlib/matplotlib/issues/3135>`__. You can get matplotlib to use these fonts by expanding the \"collections\" into individual ``.ttf`` files with the `DFontSplitter application <https://peter.upfold.org.uk/projects/dfontsplitter>`__, then saving the files in-place or in the ``~/.proplot/fonts`` folder.\n",
+    "\n",
+    "To find font files, check the paths listed in ``OSXFontDirectories``, ``X11FontDirectories``, ``MSUserFontDirectories``, and ``MSFontDirectories`` under the `~matplotlib.font_manager` module. Note that if the font in question has a \"thin\" style, implied by file names with the word ``Thin``, `a matplotlib bug <https://github.com/matplotlib/matplotlib/issues/8788>`__ may cause these styles to override the \"normal\" style!"
    ]
   }
  ],

diff --git a/docs/index.rst b/docs/index.rst
@@ -8,7 +8,9 @@
 ProPlot
 =======
 
-A comprehensive, easy-to-use `matplotlib <https://matplotlib.org/>`__ wrapper for making beautiful, publication-quality graphics. The Github page is `here <https://github.com/lukelbd/proplot>`__.
+A comprehensive, easy-to-use `matplotlib <https://matplotlib.org/>`__ wrapper for making beautiful, publication-quality graphics. This project is published `on GitHub <https://github.com/lukelbd/proplot>`__.
+
+Please note that due to my day job as a graduate student, `certain feature additions <https://github.com/lukelbd/proplot/pulls?q=is%3Aopen+is%3Apr>`__ will be delayed to the summer of 2020. In the meantime, if you are interested in contributing to ProPlot, please see the :ref:`Contribution guide`. Any amount of help is welcome!
 
 .. toctree::
    :maxdepth: 1

diff --git a/docs/why.rst b/docs/why.rst
@@ -516,18 +516,6 @@ ipython session, simply call
 `~proplot.styletools.register_cycles`, and
 `~proplot.styletools.register_fonts`.
 
-ProPlot also changes the default font to Helvetica or Arial if they are
-available (see `~proplot.rctools.use_font`).
-Matplotlib uses DejaVu Sans by default because
-DejaVu Sans is open source and can be *included* in the matplotlib distribution.
-However Helvetica and Arial are much more mature, respected,
-and (in this developer's humble opinion)
-aesthetically pleasing. Thus, ProPlot trades aesthetics for consistency --
-the default font now depends on your machine.
-The examples on this website use DejaVu Sans
-because Helvetica and Arial are both unavailable on
-the `RTD server <https://readthedocs.org>`__.
-
 ..
    As mentioned above,
    ProPlot introduces the `~proplot.styletools.Colormap` and  `~proplot.styletools.Cycle`.

diff --git a/proplot/.proplotrc b/proplot/.proplotrc
@@ -12,7 +12,7 @@ coast:        False
 color:        k
 cycle:        colorblind
 facecolor:    w
-fontname:     auto
+fontname:     "sans-serif"
 geogrid:      True
 grid:         True
 gridminor:    False

diff --git a/proplot/fonts/FiraMath-Bold.ttf b/proplot/fonts/FiraMath-Bold.ttf
diff --git a/proplot/fonts/FiraMath-Book.ttf b/proplot/fonts/FiraMath-Book.ttf
diff --git a/proplot/fonts/FiraMath-ExtraBold.ttf b/proplot/fonts/FiraMath-ExtraBold.ttf
diff --git a/proplot/fonts/FiraMath-ExtraLight.ttf b/proplot/fonts/FiraMath-ExtraLight.ttf
diff --git a/proplot/fonts/FiraMath-Heavy.ttf b/proplot/fonts/FiraMath-Heavy.ttf
diff --git a/proplot/fonts/FiraMath-Light.ttf b/proplot/fonts/FiraMath-Light.ttf
diff --git a/proplot/fonts/FiraMath-Medium.ttf b/proplot/fonts/FiraMath-Medium.ttf
diff --git a/proplot/fonts/FiraMath-Regular.ttf b/proplot/fonts/FiraMath-Regular.ttf
diff --git a/proplot/fonts/FiraMath-SemiBold.ttf b/proplot/fonts/FiraMath-SemiBold.ttf
diff --git a/proplot/fonts/FiraMath-Ultra.ttf b/proplot/fonts/FiraMath-Ultra.ttf
diff --git a/proplot/fonts/FiraMath-UltraLight.ttf b/proplot/fonts/FiraMath-UltraLight.ttf
diff --git a/proplot/fonts/FiraSans-Bold.otf b/proplot/fonts/FiraSans-Bold.otf
diff --git a/proplot/fonts/FiraSans-Bold.ttf b/proplot/fonts/FiraSans-Bold.ttf
diff --git a/proplot/fonts/FiraSans-BoldItalic.otf b/proplot/fonts/FiraSans-BoldItalic.otf
diff --git a/proplot/fonts/FiraSans-BoldItalic.ttf b/proplot/fonts/FiraSans-BoldItalic.ttf
diff --git a/proplot/fonts/FiraSans-Book.otf b/proplot/fonts/FiraSans-Book.otf
diff --git a/proplot/fonts/FiraSans-BookItalic.otf b/proplot/fonts/FiraSans-BookItalic.otf
diff --git a/proplot/fonts/FiraSans-ExtraBold.otf b/proplot/fonts/FiraSans-ExtraBold.otf
diff --git a/proplot/fonts/FiraSans-ExtraBold.ttf b/proplot/fonts/FiraSans-ExtraBold.ttf
diff --git a/proplot/fonts/FiraSans-ExtraBoldItalic.otf b/proplot/fonts/FiraSans-ExtraBoldItalic.otf
diff --git a/proplot/fonts/FiraSans-ExtraBoldItalic.ttf b/proplot/fonts/FiraSans-ExtraBoldItalic.ttf
diff --git a/proplot/fonts/FiraSans-ExtraLight.otf b/proplot/fonts/FiraSans-ExtraLight.otf
diff --git a/proplot/fonts/FiraSans-ExtraLight.ttf b/proplot/fonts/FiraSans-ExtraLight.ttf
diff --git a/proplot/fonts/FiraSans-ExtraLightItalic.otf b/proplot/fonts/FiraSans-ExtraLightItalic.otf
diff --git a/proplot/fonts/FiraSans-ExtraLightItalic.ttf b/proplot/fonts/FiraSans-ExtraLightItalic.ttf
diff --git a/proplot/fonts/FiraSans-Heavy.otf b/proplot/fonts/FiraSans-Heavy.otf
diff --git a/proplot/fonts/FiraSans-Heavy.ttf b/proplot/fonts/FiraSans-Heavy.ttf
diff --git a/proplot/fonts/FiraSans-HeavyItalic.otf b/proplot/fonts/FiraSans-HeavyItalic.otf
diff --git a/proplot/fonts/FiraSans-HeavyItalic.ttf b/proplot/fonts/FiraSans-HeavyItalic.ttf
diff --git a/proplot/fonts/FiraSans-Italic.otf b/proplot/fonts/FiraSans-Italic.otf
diff --git a/proplot/fonts/FiraSans-Italic.ttf b/proplot/fonts/FiraSans-Italic.ttf
diff --git a/proplot/fonts/FiraSans-Light.otf b/proplot/fonts/FiraSans-Light.otf
diff --git a/proplot/fonts/FiraSans-Light.ttf b/proplot/fonts/FiraSans-Light.ttf
diff --git a/proplot/fonts/FiraSans-LightItalic.otf b/proplot/fonts/FiraSans-LightItalic.otf
diff --git a/proplot/fonts/FiraSans-LightItalic.ttf b/proplot/fonts/FiraSans-LightItalic.ttf
diff --git a/proplot/fonts/FiraSans-Medium.otf b/proplot/fonts/FiraSans-Medium.otf
diff --git a/proplot/fonts/FiraSans-Medium.ttf b/proplot/fonts/FiraSans-Medium.ttf
diff --git a/proplot/fonts/FiraSans-MediumItalic.otf b/proplot/fonts/FiraSans-MediumItalic.otf
diff --git a/proplot/fonts/FiraSans-MediumItalic.ttf b/proplot/fonts/FiraSans-MediumItalic.ttf
diff --git a/proplot/fonts/FiraSans-Regular.otf b/proplot/fonts/FiraSans-Regular.otf
diff --git a/proplot/fonts/FiraSans-Regular.ttf b/proplot/fonts/FiraSans-Regular.ttf
diff --git a/proplot/fonts/FiraSans-SemiBold.otf b/proplot/fonts/FiraSans-SemiBold.otf
diff --git a/proplot/fonts/FiraSans-SemiBold.ttf b/proplot/fonts/FiraSans-SemiBold.ttf
diff --git a/proplot/fonts/FiraSans-SemiBoldItalic.otf b/proplot/fonts/FiraSans-SemiBoldItalic.otf
diff --git a/proplot/fonts/FiraSans-SemiBoldItalic.ttf b/proplot/fonts/FiraSans-SemiBoldItalic.ttf
diff --git a/proplot/fonts/LICENSE-TEXGYREHEROS.txt b/proplot/fonts/LICENSE-TEXGYREHEROS.txt
@@ -0,0 +1,29 @@
+This is a preliminary version (2006-09-30), barring acceptance from
+the LaTeX Project Team and other feedback, of the GUST Font License.
+(GUST is the Polish TeX Users Group, http://www.gust.org.pl)
+
+For the most recent version of this license see
+http://www.gust.org.pl/fonts/licenses/GUST-FONT-LICENSE.txt
+or
+http://tug.org/fonts/licenses/GUST-FONT-LICENSE.txt
+
+This work may be distributed and/or modified under the conditions
+of the LaTeX Project Public License, either version 1.3c of this
+license or (at your option) any later version.
+
+Please also observe the following clause:
+1) it is requested, but not legally required, that derived works be
+   distributed only after changing the names of the fonts comprising this
+   work and given in an accompanying "manifest", and that the
+   files comprising the Work, as listed in the manifest, also be given
+   new names. Any exceptions to this request are also given in the
+   manifest.
+
+   We recommend the manifest be given in a separate file named
+   MANIFEST-<fontid>.txt, where <fontid> is some unique identification
+   of the font family. If a separate "readme" file accompanies the Work,
+   we recommend a name of the form README-<fontid>.txt.
+
+The latest version of the LaTeX Project Public License is in
+http://www.latex-project.org/lppl.txt and version 1.3c or later
+is part of all distributions of LaTeX version 2006/05/20 or later.
diff --git a/proplot/fonts/LICENSE_FIRAMATH.txt b/proplot/fonts/LICENSE_FIRAMATH.txt
@@ -0,0 +1,92 @@
+Copyright (C) 2018, 2019 by Xiangdong Zeng <xdzeng96@gmail.com>
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+http://scripts.sil.org/OFL
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded,
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION AND CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.
diff --git a/proplot/fonts/texgyreheros-bold.ttf b/proplot/fonts/texgyreheros-bold.ttf
diff --git a/proplot/fonts/texgyreheros-bolditalic.ttf b/proplot/fonts/texgyreheros-bolditalic.ttf
diff --git a/proplot/fonts/texgyreheros-italic.ttf b/proplot/fonts/texgyreheros-italic.ttf
diff --git a/proplot/fonts/texgyreheros-regular.ttf b/proplot/fonts/texgyreheros-regular.ttf