Skip to content

Commit

Permalink
Update docs (again), finally split notebook into components
Browse files Browse the repository at this point in the history
  • Loading branch information
lukelbd committed Sep 17, 2019
1 parent de57847 commit 394f451
Show file tree
Hide file tree
Showing 102 changed files with 165,933 additions and 154,437 deletions.
486 changes: 137 additions & 349 deletions docs/tutorial1.rst → docs/basics.rst

Large diffs are not rendered by default.

7,481 changes: 7,481 additions & 0 deletions docs/basics/basics_10_0.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3,362 changes: 1,711 additions & 1,651 deletions docs/tutorial/tutorial_14_0.svg → docs/basics/basics_12_0.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2,524 changes: 1,262 additions & 1,262 deletions docs/tutorial/tutorial_15_0.svg → docs/basics/basics_13_0.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
27,710 changes: 27,710 additions & 0 deletions docs/basics/basics_15_1.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13,623 changes: 13,623 additions & 0 deletions docs/basics/basics_16_0.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
3,998 changes: 2,024 additions & 1,974 deletions docs/tutorial/tutorial_44_1.svg → docs/basics/basics_27_0.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
2,182 changes: 2,182 additions & 0 deletions docs/basics/basics_4_0.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2,044 changes: 1,019 additions & 1,025 deletions docs/tutorial/tutorial_6_1.svg → docs/basics/basics_6_0.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2,528 changes: 1,218 additions & 1,310 deletions docs/tutorial/tutorial_6_2.svg → docs/basics/basics_6_1.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
540 changes: 176 additions & 364 deletions docs/tutorial/tutorial_39_0.svg → docs/basics/basics_6_2.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5,192 changes: 2,538 additions & 2,654 deletions docs/tutorial/tutorial_8_0.svg → docs/basics/basics_8_0.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
28 changes: 14 additions & 14 deletions docs/tutorial2.rst → docs/cartesian.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@

Cartesian axes
==============

Expand Down Expand Up @@ -43,7 +44,7 @@ usually what you’ll want in this context. See
.. image:: tutorial/tutorial_48_0.svg
.. image:: cartesian/cartesian_3_0.svg


Axis tick label formatting
Expand Down Expand Up @@ -72,7 +73,7 @@ some data range*, as demonstrated below. See
.. image:: tutorial/tutorial_51_0.svg
.. image:: cartesian/cartesian_6_0.svg


ProPlot also lets you easily change the axis formatter with
Expand Down Expand Up @@ -107,7 +108,7 @@ See `~proplot.axes.CartesianAxes.format` and
.. image:: tutorial/tutorial_53_0.svg
.. image:: cartesian/cartesian_8_0.svg


New and old axis scales
Expand Down Expand Up @@ -157,7 +158,7 @@ labeling spectral coordinates (this is more useful with the
.. image:: tutorial/tutorial_56_1.svg
.. image:: cartesian/cartesian_11_1.svg


.. code:: ipython3
Expand Down Expand Up @@ -187,7 +188,7 @@ labeling spectral coordinates (this is more useful with the
.. image:: tutorial/tutorial_57_0.svg
.. image:: cartesian/cartesian_12_0.svg


.. code:: ipython3
Expand Down Expand Up @@ -227,7 +228,7 @@ labeling spectral coordinates (this is more useful with the
.. image:: tutorial/tutorial_58_0.svg
.. image:: cartesian/cartesian_13_0.svg


Datetime axis formatting
Expand Down Expand Up @@ -271,7 +272,7 @@ details.
.. image:: tutorial/tutorial_61_0.svg
.. image:: cartesian/cartesian_16_0.svg


Dual unit axes
Expand Down Expand Up @@ -323,11 +324,11 @@ pass the name of any registered “axis scale” to the ``xscale`` or
.. image:: tutorial/tutorial_64_1.svg
.. image:: cartesian/cartesian_19_1.svg



.. image:: tutorial/tutorial_64_2.svg
.. image:: cartesian/cartesian_19_2.svg


.. code:: ipython3
Expand Down Expand Up @@ -358,7 +359,7 @@ pass the name of any registered “axis scale” to the ``xscale`` or
.. image:: tutorial/tutorial_65_1.svg
.. image:: cartesian/cartesian_20_1.svg


Panel axes
Expand Down Expand Up @@ -387,7 +388,7 @@ centering spanning axis labels and super titles, pass
.. image:: tutorial/tutorial_67_0.svg
.. image:: cartesian/cartesian_22_0.svg


.. code:: ipython3
Expand All @@ -410,7 +411,7 @@ centering spanning axis labels and super titles, pass
.. image:: tutorial/tutorial_68_0.svg
.. image:: cartesian/cartesian_23_0.svg


Inset axes
Expand Down Expand Up @@ -446,6 +447,5 @@ the ``zoom_kw`` argument.
.. image:: tutorial/tutorial_70_0.svg

.. image:: cartesian/cartesian_25_0.svg

File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
48 changes: 24 additions & 24 deletions docs/tutorial4.rst → docs/colors.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@

Color usage
===========

Expand Down Expand Up @@ -74,7 +75,7 @@ See `~proplot.styletools.CmapDict` for more info.
.. image:: tutorial/tutorial_97_0.svg
.. image:: colors/colors_3_0.svg


Perceptually uniform colormaps
Expand Down Expand Up @@ -118,7 +119,7 @@ represent “impossible” colors.
.. image:: tutorial/tutorial_100_0.svg
.. image:: colors/colors_6_0.svg


.. code:: ipython3
Expand All @@ -128,7 +129,7 @@ represent “impossible” colors.
.. image:: tutorial/tutorial_101_0.svg
.. image:: colors/colors_7_0.svg


.. code:: ipython3
Expand All @@ -138,7 +139,7 @@ represent “impossible” colors.
.. image:: tutorial/tutorial_102_0.svg
.. image:: colors/colors_8_0.svg


To see how any colormap varies with respect to each channel, use the
Expand All @@ -158,7 +159,7 @@ linear in the HPL scaling of the chroma channel (bottom right).
.. image:: tutorial/tutorial_104_0.svg
.. image:: colors/colors_10_0.svg


Making your own colormaps
Expand Down Expand Up @@ -199,11 +200,11 @@ several of these maps merged into one, and the second is just one map.
.. image:: tutorial/tutorial_108_0.svg
.. image:: colors/colors_14_0.svg



.. image:: tutorial/tutorial_108_1.svg
.. image:: colors/colors_14_1.svg


To generate `~proplot.styletools.PerceptuallyUniformColormap` maps,
Expand Down Expand Up @@ -251,11 +252,11 @@ value by the number ``N``, as shown below.
.. image:: tutorial/tutorial_110_0.svg
.. image:: colors/colors_16_0.svg



.. image:: tutorial/tutorial_110_1.svg
.. image:: colors/colors_16_1.svg


Merging colormaps
Expand Down Expand Up @@ -292,7 +293,7 @@ example <https://sciviscolor.org/wp-content/uploads/sites/14/2018/04/colormoves-
.. image:: tutorial/tutorial_113_1.svg
.. image:: colors/colors_19_1.svg


Modifying colormaps
Expand Down Expand Up @@ -342,11 +343,11 @@ distinct, so that levels don’t blur together.
.. image:: tutorial/tutorial_116_0.svg
.. image:: colors/colors_22_0.svg



.. image:: tutorial/tutorial_116_1.svg
.. image:: colors/colors_22_1.svg


You can also change the “gamma” of any
Expand Down Expand Up @@ -378,11 +379,11 @@ emphasizes low luminance, high saturation colors. See
.. image:: tutorial/tutorial_118_0.svg
.. image:: colors/colors_24_0.svg



.. image:: tutorial/tutorial_118_1.svg
.. image:: colors/colors_24_1.svg


Adding online colormaps
Expand Down Expand Up @@ -419,7 +420,7 @@ differences between colormaps and color cycles.
.. image:: tutorial/tutorial_123_0.svg
.. image:: colors/colors_29_0.svg


Making your own color cycles
Expand Down Expand Up @@ -460,7 +461,7 @@ the global property cycler, use the ``plot.rc.cycle`` setting (see the
.. image:: tutorial/tutorial_126_0.svg
.. image:: colors/colors_32_0.svg


Colormaps or combinations thereof can be used as sources for making
Expand Down Expand Up @@ -492,7 +493,7 @@ details.
.. image:: tutorial/tutorial_128_0.svg
.. image:: colors/colors_34_0.svg


`~proplot.styletools.Cycle` can also generate cyclers that change
Expand All @@ -514,7 +515,7 @@ simply use ``plot.rc['axes.prop_cycle'] = cycle``.
.. image:: tutorial/tutorial_130_0.svg
.. image:: colors/colors_36_0.svg


Adding online color cycles
Expand Down Expand Up @@ -563,11 +564,11 @@ were also cleaned up – for example, “reddish” and “reddy” are changed
.. image:: tutorial/tutorial_135_0.svg
.. image:: colors/colors_41_0.svg



.. image:: tutorial/tutorial_135_1.svg
.. image:: colors/colors_41_1.svg


Individual color sampling
Expand Down Expand Up @@ -605,12 +606,12 @@ by the `~proplot.styletools.ColorCacheDict` class.
h = ax.plot((np.random.rand(20)-0.4).cumsum(), lw=5, color=('qual1', idx),
label=f'idx {idx:.0f}', legend='r', legend_kw={'ncols':1})
ax.format(title='Drawing from the ggplot color cycle')
axs.format(xlocator='null', abc=True, abcloc='ur', abcformat='A.',
axs.format(xlocator='null', abc=True, abcloc='ur', abcstyle='A.',
suptitle='Getting individual colors from colormaps and cycles')
.. image:: tutorial/tutorial_138_0.svg
.. image:: colors/colors_44_0.svg


Font selection
Expand Down Expand Up @@ -639,6 +640,5 @@ modify your ``~/.proplotrc``. See the `~proplot.styletools` and
.. image:: tutorial/tutorial_141_0.svg

.. image:: colors/colors_47_0.svg

File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
12 changes: 6 additions & 6 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -91,13 +91,13 @@ To get started, check out the :ref:`Introduction`.
.. toctree::
:hidden:
:maxdepth: 4
:caption: Tutorial
:caption: Overview

tutorial1
tutorial2
tutorial3
tutorial4
tutorial5
basics
cartesian
projection
colors
plotting

.. toctree::
:hidden:
Expand Down

0 comments on commit 394f451

Please sign in to comment.