diff --git a/docs/build/_images/cf_gallery_image.png b/docs/build/_images/cf_gallery_image.png new file mode 100644 index 0000000..ed7290b Binary files /dev/null and b/docs/build/_images/cf_gallery_image.png differ diff --git a/docs/build/_images/cm.png b/docs/build/_images/cm.png new file mode 100644 index 0000000..128cad9 Binary files /dev/null and b/docs/build/_images/cm.png differ diff --git a/docs/build/_images/scale1_original.png b/docs/build/_images/scale1_original.png new file mode 100644 index 0000000..f475e11 Binary files /dev/null and b/docs/build/_images/scale1_original.png differ diff --git a/docs/build/_sources/advanced.rst.txt b/docs/build/_sources/advanced.rst.txt index 1692de2..15e6651 100644 --- a/docs/build/_sources/advanced.rst.txt +++ b/docs/build/_sources/advanced.rst.txt @@ -1,4 +1,7 @@ +:orphan: + .. _advanced: + Advanced Use ************ diff --git a/docs/build/_sources/cbar.rst.txt b/docs/build/_sources/cbar.rst.txt index d3fe5a3..b46db85 100644 --- a/docs/build/_sources/cbar.rst.txt +++ b/docs/build/_sources/cbar.rst.txt @@ -1,4 +1,5 @@ .. _cbar: + cbar **** diff --git a/docs/build/_sources/colour_scales.rst.txt b/docs/build/_sources/colour_scales.rst.txt index 67a5046..2db3a29 100644 --- a/docs/build/_sources/colour_scales.rst.txt +++ b/docs/build/_sources/colour_scales.rst.txt @@ -1,4 +1,7 @@ +:orphan: + .. _colour_scales: + Colour scales ************* diff --git a/docs/build/_sources/con.rst.txt b/docs/build/_sources/con.rst.txt index 6dc25f6..67fa4a6 100644 --- a/docs/build/_sources/con.rst.txt +++ b/docs/build/_sources/con.rst.txt @@ -1,4 +1,5 @@ .. _con: + con *** diff --git a/docs/build/_sources/cscale.rst.txt b/docs/build/_sources/cscale.rst.txt index 7683f85..89ae7d1 100644 --- a/docs/build/_sources/cscale.rst.txt +++ b/docs/build/_sources/cscale.rst.txt @@ -1,4 +1,5 @@ .. _cscale: + cscale ****** diff --git a/docs/build/_sources/cylindrical.rst.txt b/docs/build/_sources/cylindrical.rst.txt index 4330bbb..a833e4a 100644 --- a/docs/build/_sources/cylindrical.rst.txt +++ b/docs/build/_sources/cylindrical.rst.txt @@ -1,4 +1,7 @@ +:orphan: + .. _cylindrical: + Cylindrical projection ********************** diff --git a/docs/build/_sources/download.rst.txt b/docs/build/_sources/download.rst.txt index 6206d22..e08da0d 100644 --- a/docs/build/_sources/download.rst.txt +++ b/docs/build/_sources/download.rst.txt @@ -1,4 +1,7 @@ +:orphan: + .. _download: + Download/Install **************** diff --git a/docs/build/_sources/gallery.rst.txt b/docs/build/_sources/gallery.rst.txt index 5c99a26..86c8f5c 100644 --- a/docs/build/_sources/gallery.rst.txt +++ b/docs/build/_sources/gallery.rst.txt @@ -1,3 +1,5 @@ +:orphan: + cf-plot gallery =============== @@ -35,7 +37,7 @@ cf-plot gallery :target: colour_scales.html :ref:`Vector plots ` | -:ref:`Stipple plots ` | +:ref:`Stipple plots ` | :ref:`Multiple plots on a page` | :ref:`Colour scales ` diff --git a/docs/build/_sources/gclose.rst.txt b/docs/build/_sources/gclose.rst.txt index 57bebee..3aa3bfc 100644 --- a/docs/build/_sources/gclose.rst.txt +++ b/docs/build/_sources/gclose.rst.txt @@ -1,4 +1,5 @@ .. _gclose: + gclose ****** diff --git a/docs/build/_sources/gopen.rst.txt b/docs/build/_sources/gopen.rst.txt index ea50b1a..ed7f642 100644 --- a/docs/build/_sources/gopen.rst.txt +++ b/docs/build/_sources/gopen.rst.txt @@ -1,4 +1,5 @@ .. _gopen: + gopen ***** diff --git a/docs/build/_sources/gpos.rst.txt b/docs/build/_sources/gpos.rst.txt index 5f0c04d..f7f3c3e 100644 --- a/docs/build/_sources/gpos.rst.txt +++ b/docs/build/_sources/gpos.rst.txt @@ -1,4 +1,5 @@ .. _gpos: + gpos **** diff --git a/docs/build/_sources/graphs.rst.txt b/docs/build/_sources/graphs.rst.txt index 818b261..60c334d 100644 --- a/docs/build/_sources/graphs.rst.txt +++ b/docs/build/_sources/graphs.rst.txt @@ -1,4 +1,7 @@ +:orphan: + .. _graphs: + Graphs ****** diff --git a/docs/build/_sources/gset.rst.txt b/docs/build/_sources/gset.rst.txt index d0a8767..a007bdb 100644 --- a/docs/build/_sources/gset.rst.txt +++ b/docs/build/_sources/gset.rst.txt @@ -1,4 +1,5 @@ .. _gset: + gset **** diff --git a/docs/build/_sources/hovmuller.rst.txt b/docs/build/_sources/hovmuller.rst.txt index a21609c..12a9dd1 100644 --- a/docs/build/_sources/hovmuller.rst.txt +++ b/docs/build/_sources/hovmuller.rst.txt @@ -1,9 +1,12 @@ +:orphan: + .. _hovmuller: + Hovmuller plots *************** Example 10 - latitude-time -------------------------- +-------------------------- .. image:: images/fig10.png :scale: 52% diff --git a/docs/build/_sources/internal_routines.rst.txt b/docs/build/_sources/internal_routines.rst.txt index 49aee5b..777efa0 100644 --- a/docs/build/_sources/internal_routines.rst.txt +++ b/docs/build/_sources/internal_routines.rst.txt @@ -1,3 +1,5 @@ +:orphan: + Internal routines ***************** diff --git a/docs/build/_sources/issues.rst.txt b/docs/build/_sources/issues.rst.txt index 05861fa..069c637 100644 --- a/docs/build/_sources/issues.rst.txt +++ b/docs/build/_sources/issues.rst.txt @@ -1,3 +1,5 @@ +:orphan: + cf-plot issues ************** diff --git a/docs/build/_sources/levs.rst.txt b/docs/build/_sources/levs.rst.txt index 9621193..bbd0f68 100644 --- a/docs/build/_sources/levs.rst.txt +++ b/docs/build/_sources/levs.rst.txt @@ -1,4 +1,5 @@ .. _levs: + levs **** diff --git a/docs/build/_sources/license.rst.txt b/docs/build/_sources/license.rst.txt index 0e80248..e93daec 100644 --- a/docs/build/_sources/license.rst.txt +++ b/docs/build/_sources/license.rst.txt @@ -1,3 +1,5 @@ +:orphan: + License ******* diff --git a/docs/build/_sources/lineplot.rst.txt b/docs/build/_sources/lineplot.rst.txt index 5cdcebb..5149c30 100644 --- a/docs/build/_sources/lineplot.rst.txt +++ b/docs/build/_sources/lineplot.rst.txt @@ -1,4 +1,5 @@ .. _lineplot: + lineplot ******** diff --git a/docs/build/_sources/mapset.rst.txt b/docs/build/_sources/mapset.rst.txt index 4efd35d..51ff55b 100644 --- a/docs/build/_sources/mapset.rst.txt +++ b/docs/build/_sources/mapset.rst.txt @@ -1,4 +1,5 @@ .. _mapset: + mapset ****** diff --git a/docs/build/_sources/multiple_plots.rst.txt b/docs/build/_sources/multiple_plots.rst.txt index 7965f2b..12f3ddd 100644 --- a/docs/build/_sources/multiple_plots.rst.txt +++ b/docs/build/_sources/multiple_plots.rst.txt @@ -1,4 +1,7 @@ +:orphan: + .. _multiple_plots: + Multiple plots ************** diff --git a/docs/build/_sources/older_documentation.rst.txt b/docs/build/_sources/older_documentation.rst.txt index 1c3c793..ba2cc31 100644 --- a/docs/build/_sources/older_documentation.rst.txt +++ b/docs/build/_sources/older_documentation.rst.txt @@ -1,3 +1,4 @@ +:orphan: Older documentation ******************* diff --git a/docs/build/_sources/polar.rst.txt b/docs/build/_sources/polar.rst.txt index 155beeb..a2e0c26 100644 --- a/docs/build/_sources/polar.rst.txt +++ b/docs/build/_sources/polar.rst.txt @@ -1,4 +1,7 @@ +:orphan: + .. _polar: + Polar stereographic projection ****************************** diff --git a/docs/build/_sources/pressure.rst.txt b/docs/build/_sources/pressure.rst.txt index 5132929..5ad0ba9 100644 --- a/docs/build/_sources/pressure.rst.txt +++ b/docs/build/_sources/pressure.rst.txt @@ -1,4 +1,7 @@ +:orphan: + .. _pressure: + Latitude / longitude - pressure ******************************* diff --git a/docs/build/_sources/projections.rst.txt b/docs/build/_sources/projections.rst.txt index 7d88ab3..13e7663 100644 --- a/docs/build/_sources/projections.rst.txt +++ b/docs/build/_sources/projections.rst.txt @@ -1,4 +1,7 @@ +:orphan: + .. _projections: + Projections in cf-plot ********************** diff --git a/docs/build/_sources/reset.rst.txt b/docs/build/_sources/reset.rst.txt index 381cd4a..17298de 100644 --- a/docs/build/_sources/reset.rst.txt +++ b/docs/build/_sources/reset.rst.txt @@ -1,4 +1,5 @@ .. _reset: + reset ***** diff --git a/docs/build/_sources/rotated_pole.rst.txt b/docs/build/_sources/rotated_pole.rst.txt index c5d8a63..16e63f4 100644 --- a/docs/build/_sources/rotated_pole.rst.txt +++ b/docs/build/_sources/rotated_pole.rst.txt @@ -1,4 +1,7 @@ +:orphan: + .. _rotated_pole: + Rotated pole plots ****************** @@ -28,7 +31,8 @@ Example 22 - rotated pole data on the native grid This plot shows some rotated pole data on the native grid. Notice the way that the longitude lines are warped away from the centre of the plot. Data over the equatorial regions show little of this warping. .. image:: images/fig22.png - :scale: 52% + :scale: 52% + :: import cf diff --git a/docs/build/_sources/routines.rst.txt b/docs/build/_sources/routines.rst.txt index 5c2bb7d..2613746 100644 --- a/docs/build/_sources/routines.rst.txt +++ b/docs/build/_sources/routines.rst.txt @@ -1,3 +1,5 @@ +:orphan: + Routines ******** diff --git a/docs/build/_sources/setvars.rst.txt b/docs/build/_sources/setvars.rst.txt index 78cbf4b..aa0c992 100644 --- a/docs/build/_sources/setvars.rst.txt +++ b/docs/build/_sources/setvars.rst.txt @@ -1,4 +1,5 @@ .. _setvars: + setvars ******* diff --git a/docs/build/_sources/stipple.rst.txt b/docs/build/_sources/stipple.rst.txt index a9b86dc..fd9f878 100644 --- a/docs/build/_sources/stipple.rst.txt +++ b/docs/build/_sources/stipple.rst.txt @@ -1,4 +1,5 @@ .. _stipple: + stipple ******* diff --git a/docs/build/_sources/stipple_plots.rst.txt b/docs/build/_sources/stipple_plots.rst.txt index ceb6a0c..5479a96 100644 --- a/docs/build/_sources/stipple_plots.rst.txt +++ b/docs/build/_sources/stipple_plots.rst.txt @@ -1,4 +1,7 @@ -.. _stipple: +:orphan: + +.. _stippleplots: + Stipple plots ************* diff --git a/docs/build/_sources/timeaxis.rst.txt b/docs/build/_sources/timeaxis.rst.txt new file mode 100644 index 0000000..98a182e --- /dev/null +++ b/docs/build/_sources/timeaxis.rst.txt @@ -0,0 +1,5 @@ +timeaxis +******** + +.. autofunction:: cfplot.timeaxis + diff --git a/docs/build/_sources/training.rst.txt b/docs/build/_sources/training.rst.txt index 776a3ae..df5c130 100644 --- a/docs/build/_sources/training.rst.txt +++ b/docs/build/_sources/training.rst.txt @@ -1,4 +1,7 @@ +:orphan: + .. _training: + Training material ***************** diff --git a/docs/build/_sources/traj.rst.txt b/docs/build/_sources/traj.rst.txt index dd3fc41..a7a2127 100644 --- a/docs/build/_sources/traj.rst.txt +++ b/docs/build/_sources/traj.rst.txt @@ -1,4 +1,5 @@ .. _traj: + traj **** diff --git a/docs/build/_sources/trajectories.rst.txt b/docs/build/_sources/trajectories.rst.txt index 6c0c116..7504bb6 100644 --- a/docs/build/_sources/trajectories.rst.txt +++ b/docs/build/_sources/trajectories.rst.txt @@ -1,4 +1,7 @@ +:orphan: + .. _trajectories: + Trajectories ************ @@ -136,9 +139,5 @@ Example 42a - intensity legend with lines cfp.traj(g, legend_lines=True, linewidth=2, colorbar_title='Relative Vorticity (Hz) * 1e5') -| Selecting legend_lines=True plots lines only and colours them according to the sum of the start and end point divided by two. This can be a useful option when there are lots of trajectories. -| -| - diff --git a/docs/build/_sources/unstructured.rst.txt b/docs/build/_sources/unstructured.rst.txt index 9d3e425..8010ad5 100644 --- a/docs/build/_sources/unstructured.rst.txt +++ b/docs/build/_sources/unstructured.rst.txt @@ -1,4 +1,7 @@ +:orphan: + .. _unstructured: + Unstructured grids ****************** diff --git a/docs/build/_sources/user_defined.rst.txt b/docs/build/_sources/user_defined.rst.txt index cb41798..51afa50 100644 --- a/docs/build/_sources/user_defined.rst.txt +++ b/docs/build/_sources/user_defined.rst.txt @@ -1,4 +1,7 @@ +:orphan: + .. _user_defined: + User defined axes ***************** diff --git a/docs/build/_sources/user_guide.rst.txt b/docs/build/_sources/user_guide.rst.txt index cec47e3..1c3d3b9 100644 --- a/docs/build/_sources/user_guide.rst.txt +++ b/docs/build/_sources/user_guide.rst.txt @@ -1,3 +1,5 @@ +:orphan: + ****************** cf-plot user guide ****************** @@ -11,9 +13,9 @@ cf-plot user guide | contours_ - making contour plots | vectors_ - plotting vectors | multiple_ plots on a page and plot positioning -| trajectories_ - plotting trajectories +| trajectoriesUG_ - plotting trajectories | significance_ - plots -| graphs_ - making graphs +| graphsUG_ - making graphs | colour_ scales - using and changing colour scales | | appendixA_ - introduction to cf-python @@ -482,7 +484,7 @@ Plot spacing options are located in **cfp.gopen** | hspace=None - height reserved for white space between subplots - default=0.2 | | -|and color bar spacings in **cfp.cbar**. +| and color bar spacings in **cfp.cbar**. | | orientation - orientation 'horizontal' or 'vertical' | position - user specified colorbar position in normalised @@ -578,7 +580,7 @@ colour bars on the plot with different colour scales and contour levels. cfp.gclose() -.. _trajectories: +.. _trajectoriesUG: ^^^^^^^^^^^^ Trajectories @@ -656,7 +658,7 @@ A stipple plot is usually used to show areas of significance such as 95% or grea | -.. _graphs: +.. _graphsUG: ^^^^^^^^^^^ @@ -1143,7 +1145,7 @@ scale44 .. image:: images/colour_scales/scale44.png Colour bars ^^^^^^^^^^^ -Colour bars are often associated with filled colour contour plots and the options for the colour bar are described in the :ref:`cbar` . If the colour bar options are changed within the call to **cfp.con** then prepend colorbar_ to the appropriate colour bar option. cf-plot has used the American spelling for colorbar for compatability with the spelling and usage within the Matplotlib Python package. +Colour bars are often associated with filled colour contour plots and the options for the colour bar are described in the :ref:`cbar` . If the colour bar options are changed within the call to **cfp.con** then prepend ``colorbar`` to the appropriate colour bar option. cf-plot has used the American spelling for colorbar for compatability with the spelling and usage within the Matplotlib Python package. diff --git a/docs/build/_sources/vect.rst.txt b/docs/build/_sources/vect.rst.txt index 6d76ee6..33b56f3 100644 --- a/docs/build/_sources/vect.rst.txt +++ b/docs/build/_sources/vect.rst.txt @@ -1,4 +1,5 @@ .. _vect: + vect **** diff --git a/docs/build/_sources/vectors.rst.txt b/docs/build/_sources/vectors.rst.txt index e6c3ca3..0f7bfd4 100644 --- a/docs/build/_sources/vectors.rst.txt +++ b/docs/build/_sources/vectors.rst.txt @@ -1,4 +1,7 @@ +:orphan: + .. _vector: + Vector and stream plots *********************** diff --git a/docs/build/_sources/version3_changes.rst.txt b/docs/build/_sources/version3_changes.rst.txt index 515d362..ed146ff 100644 --- a/docs/build/_sources/version3_changes.rst.txt +++ b/docs/build/_sources/version3_changes.rst.txt @@ -1,3 +1,5 @@ +:orphan: + *********************************************** Python, cf-python and cf-plot version 3 changes *********************************************** diff --git a/docs/build/_sources/version_1.3.rst.txt b/docs/build/_sources/version_1.3.rst.txt index f8bc9fe..70b36f9 100644 --- a/docs/build/_sources/version_1.3.rst.txt +++ b/docs/build/_sources/version_1.3.rst.txt @@ -1,3 +1,5 @@ +:orphan: + .. _version_1.3: version 1.3 changes diff --git a/docs/build/_sources/version_1.5.rst.txt b/docs/build/_sources/version_1.5.rst.txt index 85aa4cc..f3e2725 100644 --- a/docs/build/_sources/version_1.5.rst.txt +++ b/docs/build/_sources/version_1.5.rst.txt @@ -1,4 +1,7 @@ +:orphan: + .. _version_1.5: + version 1.5 changes ******************* diff --git a/docs/build/_sources/version_1.6.rst.txt b/docs/build/_sources/version_1.6.rst.txt index 9eab6c4..47383cd 100644 --- a/docs/build/_sources/version_1.6.rst.txt +++ b/docs/build/_sources/version_1.6.rst.txt @@ -1,4 +1,7 @@ +:orphan: + .. _version_1.6: + version 1.6 changes ******************* diff --git a/docs/build/_sources/version_1.7.rst.txt b/docs/build/_sources/version_1.7.rst.txt index 13202a6..de15905 100644 --- a/docs/build/_sources/version_1.7.rst.txt +++ b/docs/build/_sources/version_1.7.rst.txt @@ -1,4 +1,7 @@ +:orphan: + .. _version_1.7: + version 1.7 changes ******************* diff --git a/docs/build/_sources/version_1.8.rst.txt b/docs/build/_sources/version_1.8.rst.txt index cb20f89..db906ea 100644 --- a/docs/build/_sources/version_1.8.rst.txt +++ b/docs/build/_sources/version_1.8.rst.txt @@ -1,4 +1,7 @@ +:orphan: + .. _version_1.8: + version 1.8 changes ******************* diff --git a/docs/build/_sources/version_1.9.rst.txt b/docs/build/_sources/version_1.9.rst.txt index 2771b85..dfd838d 100644 --- a/docs/build/_sources/version_1.9.rst.txt +++ b/docs/build/_sources/version_1.9.rst.txt @@ -1,4 +1,7 @@ +:orphan: + .. _version_1.9: + version 1.9 changes ******************* diff --git a/docs/build/_sources/version_2.0.rst.txt b/docs/build/_sources/version_2.0.rst.txt index 16454af..e084845 100644 --- a/docs/build/_sources/version_2.0.rst.txt +++ b/docs/build/_sources/version_2.0.rst.txt @@ -1,4 +1,7 @@ +:orphan: + .. _version_2.0: + version 2.0 changes ******************* diff --git a/docs/build/_sources/version_2.1.rst.txt b/docs/build/_sources/version_2.1.rst.txt index 1291792..71f3e26 100644 --- a/docs/build/_sources/version_2.1.rst.txt +++ b/docs/build/_sources/version_2.1.rst.txt @@ -1,4 +1,7 @@ +:orphan: + .. _version_2.1: + version 2.1 changes ******************* @@ -49,8 +52,7 @@ to revert to the previous behaviour. .. image:: images/scale1_original.png :scale: 52% - - +.. comment break to prevent indent below stopping image from rendering :: @@ -94,7 +96,7 @@ Lambert conformal projections can now be cropped as in the following code: .. image:: images/cm.png :scale: 52% - +.. comment break to prevent indent below stopping image from rendering :: @@ -157,9 +159,10 @@ A new colour scale was added - brown to blue - BrBG. -.. image:: images/colourscales/BrBG.png +.. image:: images/colour_scales/BrBG.png :scale: 52% +.. comment break to prevent indent below stopping image from rendering :: diff --git a/docs/build/_sources/version_2.2.rst.txt b/docs/build/_sources/version_2.2.rst.txt index ec6e86d..57527cd 100644 --- a/docs/build/_sources/version_2.2.rst.txt +++ b/docs/build/_sources/version_2.2.rst.txt @@ -1,4 +1,7 @@ +:orphan: + .. _version_2.2: + version 2.2 changes ******************* diff --git a/docs/build/_sources/version_2.3.rst.txt b/docs/build/_sources/version_2.3.rst.txt index af17ed6..32d5e22 100644 --- a/docs/build/_sources/version_2.3.rst.txt +++ b/docs/build/_sources/version_2.3.rst.txt @@ -1,4 +1,7 @@ +:orphan: + .. _version_2.3: + version 2.3 changes ******************* diff --git a/docs/build/_sources/version_2.4.rst.txt b/docs/build/_sources/version_2.4.rst.txt index 24d7a90..a35c572 100644 --- a/docs/build/_sources/version_2.4.rst.txt +++ b/docs/build/_sources/version_2.4.rst.txt @@ -1,4 +1,7 @@ +:orphan: + .. _version_2.4: + version 2.4 changes ******************* diff --git a/docs/build/_sources/version_3.0.rst.txt b/docs/build/_sources/version_3.0.rst.txt index 613824b..6d1e6a7 100644 --- a/docs/build/_sources/version_3.0.rst.txt +++ b/docs/build/_sources/version_3.0.rst.txt @@ -1,4 +1,7 @@ +:orphan: + .. _version_3.0: + version 3.0 changes ******************* diff --git a/docs/build/_sources/version_3.1.rst.txt b/docs/build/_sources/version_3.1.rst.txt index 99153ba..010b3df 100644 --- a/docs/build/_sources/version_3.1.rst.txt +++ b/docs/build/_sources/version_3.1.rst.txt @@ -1,4 +1,7 @@ +:orphan: + .. _version_3.1: + version 3.1 changes ******************* @@ -89,7 +92,7 @@ cf-python 3.8.0. The longer form always works and so this has been adopted. 10. cfp.gpos(1) causes stray box lines -===================================== +====================================== When making multiple plots on a page calling cfp.gpos(1) causes stray box lines to be added to the first plot. @@ -215,7 +218,7 @@ and another that isn't recogised as one of these. 19. cfp.con - improved Z axis detection -====================================== +======================================= The cf-plot find_dim_names routine was modified to use the cf-python get_data_axes method leading to more reliable Z axis detection when multiple Z axes are defined in the field. diff --git a/docs/build/_sources/version_3.2.rst.txt b/docs/build/_sources/version_3.2.rst.txt index 9cda03b..3421da0 100644 --- a/docs/build/_sources/version_3.2.rst.txt +++ b/docs/build/_sources/version_3.2.rst.txt @@ -1,4 +1,7 @@ +:orphan: + .. _version_3.2: + version 3.2 changes ******************* @@ -179,7 +182,7 @@ An error occured if a cell_method had no associated axis. A check was put in pl 14. cfp.con - ugrid keyword changed to irregular -=============================================== +================================================ In cfp.con the ugrid keyword was changed to irregular as this is more appropriate. diff --git a/docs/build/_sources/version_3.3.rst.txt b/docs/build/_sources/version_3.3.rst.txt index 0432f99..d016c4c 100644 --- a/docs/build/_sources/version_3.3.rst.txt +++ b/docs/build/_sources/version_3.3.rst.txt @@ -1,4 +1,7 @@ +:orphan: + .. _version_3.3: + version 3.3 changes ******************* diff --git a/docs/build/_sources/versions.rst.txt b/docs/build/_sources/versions.rst.txt index c33546b..2e49d2d 100644 --- a/docs/build/_sources/versions.rst.txt +++ b/docs/build/_sources/versions.rst.txt @@ -1,3 +1,5 @@ +:orphan: + Planned releases **************** diff --git a/docs/build/_sources/wrf.rst.txt b/docs/build/_sources/wrf.rst.txt index 9dc3afd..3ff85f4 100644 --- a/docs/build/_sources/wrf.rst.txt +++ b/docs/build/_sources/wrf.rst.txt @@ -1,4 +1,7 @@ +:orphan: + .. _wrf: + WRF data ******** diff --git a/docs/source/advanced.rst b/docs/source/advanced.rst index 1692de2..15e6651 100644 --- a/docs/source/advanced.rst +++ b/docs/source/advanced.rst @@ -1,4 +1,7 @@ +:orphan: + .. _advanced: + Advanced Use ************ diff --git a/docs/source/cbar.rst b/docs/source/cbar.rst index d3fe5a3..b46db85 100644 --- a/docs/source/cbar.rst +++ b/docs/source/cbar.rst @@ -1,4 +1,5 @@ .. _cbar: + cbar **** diff --git a/docs/source/colour_scales.rst b/docs/source/colour_scales.rst index 67a5046..2db3a29 100644 --- a/docs/source/colour_scales.rst +++ b/docs/source/colour_scales.rst @@ -1,4 +1,7 @@ +:orphan: + .. _colour_scales: + Colour scales ************* diff --git a/docs/source/con.rst b/docs/source/con.rst index 6dc25f6..67fa4a6 100644 --- a/docs/source/con.rst +++ b/docs/source/con.rst @@ -1,4 +1,5 @@ .. _con: + con *** diff --git a/docs/source/cscale.rst b/docs/source/cscale.rst index 7683f85..89ae7d1 100644 --- a/docs/source/cscale.rst +++ b/docs/source/cscale.rst @@ -1,4 +1,5 @@ .. _cscale: + cscale ****** diff --git a/docs/source/cylindrical.rst b/docs/source/cylindrical.rst index 4330bbb..a833e4a 100644 --- a/docs/source/cylindrical.rst +++ b/docs/source/cylindrical.rst @@ -1,4 +1,7 @@ +:orphan: + .. _cylindrical: + Cylindrical projection ********************** diff --git a/docs/source/download.rst b/docs/source/download.rst index 6206d22..e08da0d 100644 --- a/docs/source/download.rst +++ b/docs/source/download.rst @@ -1,4 +1,7 @@ +:orphan: + .. _download: + Download/Install **************** diff --git a/docs/source/gallery.rst b/docs/source/gallery.rst index 5c99a26..86c8f5c 100644 --- a/docs/source/gallery.rst +++ b/docs/source/gallery.rst @@ -1,3 +1,5 @@ +:orphan: + cf-plot gallery =============== @@ -35,7 +37,7 @@ cf-plot gallery :target: colour_scales.html :ref:`Vector plots ` | -:ref:`Stipple plots ` | +:ref:`Stipple plots ` | :ref:`Multiple plots on a page` | :ref:`Colour scales ` diff --git a/docs/source/gclose.rst b/docs/source/gclose.rst index 57bebee..3aa3bfc 100644 --- a/docs/source/gclose.rst +++ b/docs/source/gclose.rst @@ -1,4 +1,5 @@ .. _gclose: + gclose ****** diff --git a/docs/source/gopen.rst b/docs/source/gopen.rst index ea50b1a..ed7f642 100644 --- a/docs/source/gopen.rst +++ b/docs/source/gopen.rst @@ -1,4 +1,5 @@ .. _gopen: + gopen ***** diff --git a/docs/source/gpos.rst b/docs/source/gpos.rst index 5f0c04d..f7f3c3e 100644 --- a/docs/source/gpos.rst +++ b/docs/source/gpos.rst @@ -1,4 +1,5 @@ .. _gpos: + gpos **** diff --git a/docs/source/graphs.rst b/docs/source/graphs.rst index 818b261..60c334d 100644 --- a/docs/source/graphs.rst +++ b/docs/source/graphs.rst @@ -1,4 +1,7 @@ +:orphan: + .. _graphs: + Graphs ****** diff --git a/docs/source/gset.rst b/docs/source/gset.rst index d0a8767..a007bdb 100644 --- a/docs/source/gset.rst +++ b/docs/source/gset.rst @@ -1,4 +1,5 @@ .. _gset: + gset **** diff --git a/docs/source/hovmuller.rst b/docs/source/hovmuller.rst index a21609c..12a9dd1 100644 --- a/docs/source/hovmuller.rst +++ b/docs/source/hovmuller.rst @@ -1,9 +1,12 @@ +:orphan: + .. _hovmuller: + Hovmuller plots *************** Example 10 - latitude-time -------------------------- +-------------------------- .. image:: images/fig10.png :scale: 52% diff --git a/docs/source/internal_routines.rst b/docs/source/internal_routines.rst index 49aee5b..777efa0 100644 --- a/docs/source/internal_routines.rst +++ b/docs/source/internal_routines.rst @@ -1,3 +1,5 @@ +:orphan: + Internal routines ***************** diff --git a/docs/source/issues.rst b/docs/source/issues.rst index 05861fa..069c637 100644 --- a/docs/source/issues.rst +++ b/docs/source/issues.rst @@ -1,3 +1,5 @@ +:orphan: + cf-plot issues ************** diff --git a/docs/source/levs.rst b/docs/source/levs.rst index 9621193..bbd0f68 100644 --- a/docs/source/levs.rst +++ b/docs/source/levs.rst @@ -1,4 +1,5 @@ .. _levs: + levs **** diff --git a/docs/source/license.rst b/docs/source/license.rst index 0e80248..e93daec 100644 --- a/docs/source/license.rst +++ b/docs/source/license.rst @@ -1,3 +1,5 @@ +:orphan: + License ******* diff --git a/docs/source/lineplot.rst b/docs/source/lineplot.rst index 5cdcebb..5149c30 100644 --- a/docs/source/lineplot.rst +++ b/docs/source/lineplot.rst @@ -1,4 +1,5 @@ .. _lineplot: + lineplot ******** diff --git a/docs/source/mapset.rst b/docs/source/mapset.rst index 4efd35d..51ff55b 100644 --- a/docs/source/mapset.rst +++ b/docs/source/mapset.rst @@ -1,4 +1,5 @@ .. _mapset: + mapset ****** diff --git a/docs/source/multiple_plots.rst b/docs/source/multiple_plots.rst index 7965f2b..12f3ddd 100644 --- a/docs/source/multiple_plots.rst +++ b/docs/source/multiple_plots.rst @@ -1,4 +1,7 @@ +:orphan: + .. _multiple_plots: + Multiple plots ************** diff --git a/docs/source/older_documentation.rst b/docs/source/older_documentation.rst index 1c3c793..ba2cc31 100644 --- a/docs/source/older_documentation.rst +++ b/docs/source/older_documentation.rst @@ -1,3 +1,4 @@ +:orphan: Older documentation ******************* diff --git a/docs/source/polar.rst b/docs/source/polar.rst index 155beeb..a2e0c26 100644 --- a/docs/source/polar.rst +++ b/docs/source/polar.rst @@ -1,4 +1,7 @@ +:orphan: + .. _polar: + Polar stereographic projection ****************************** diff --git a/docs/source/pressure.rst b/docs/source/pressure.rst index 5132929..5ad0ba9 100644 --- a/docs/source/pressure.rst +++ b/docs/source/pressure.rst @@ -1,4 +1,7 @@ +:orphan: + .. _pressure: + Latitude / longitude - pressure ******************************* diff --git a/docs/source/projections.rst b/docs/source/projections.rst index 7d88ab3..13e7663 100644 --- a/docs/source/projections.rst +++ b/docs/source/projections.rst @@ -1,4 +1,7 @@ +:orphan: + .. _projections: + Projections in cf-plot ********************** diff --git a/docs/source/reset.rst b/docs/source/reset.rst index 381cd4a..17298de 100644 --- a/docs/source/reset.rst +++ b/docs/source/reset.rst @@ -1,4 +1,5 @@ .. _reset: + reset ***** diff --git a/docs/source/rotated_pole.rst b/docs/source/rotated_pole.rst index c5d8a63..16e63f4 100644 --- a/docs/source/rotated_pole.rst +++ b/docs/source/rotated_pole.rst @@ -1,4 +1,7 @@ +:orphan: + .. _rotated_pole: + Rotated pole plots ****************** @@ -28,7 +31,8 @@ Example 22 - rotated pole data on the native grid This plot shows some rotated pole data on the native grid. Notice the way that the longitude lines are warped away from the centre of the plot. Data over the equatorial regions show little of this warping. .. image:: images/fig22.png - :scale: 52% + :scale: 52% + :: import cf diff --git a/docs/source/routines.rst b/docs/source/routines.rst index 5c2bb7d..2613746 100644 --- a/docs/source/routines.rst +++ b/docs/source/routines.rst @@ -1,3 +1,5 @@ +:orphan: + Routines ******** diff --git a/docs/source/setvars.rst b/docs/source/setvars.rst index 78cbf4b..aa0c992 100644 --- a/docs/source/setvars.rst +++ b/docs/source/setvars.rst @@ -1,4 +1,5 @@ .. _setvars: + setvars ******* diff --git a/docs/source/stipple.rst b/docs/source/stipple.rst index a9b86dc..fd9f878 100644 --- a/docs/source/stipple.rst +++ b/docs/source/stipple.rst @@ -1,4 +1,5 @@ .. _stipple: + stipple ******* diff --git a/docs/source/stipple_plots.rst b/docs/source/stipple_plots.rst index ceb6a0c..5479a96 100644 --- a/docs/source/stipple_plots.rst +++ b/docs/source/stipple_plots.rst @@ -1,4 +1,7 @@ -.. _stipple: +:orphan: + +.. _stippleplots: + Stipple plots ************* diff --git a/docs/source/timeaxis.rst b/docs/source/timeaxis.rst new file mode 100644 index 0000000..98a182e --- /dev/null +++ b/docs/source/timeaxis.rst @@ -0,0 +1,5 @@ +timeaxis +******** + +.. autofunction:: cfplot.timeaxis + diff --git a/docs/source/training.rst b/docs/source/training.rst index 776a3ae..df5c130 100644 --- a/docs/source/training.rst +++ b/docs/source/training.rst @@ -1,4 +1,7 @@ +:orphan: + .. _training: + Training material ***************** diff --git a/docs/source/traj.rst b/docs/source/traj.rst index dd3fc41..a7a2127 100644 --- a/docs/source/traj.rst +++ b/docs/source/traj.rst @@ -1,4 +1,5 @@ .. _traj: + traj **** diff --git a/docs/source/trajectories.rst b/docs/source/trajectories.rst index 6c0c116..7504bb6 100644 --- a/docs/source/trajectories.rst +++ b/docs/source/trajectories.rst @@ -1,4 +1,7 @@ +:orphan: + .. _trajectories: + Trajectories ************ @@ -136,9 +139,5 @@ Example 42a - intensity legend with lines cfp.traj(g, legend_lines=True, linewidth=2, colorbar_title='Relative Vorticity (Hz) * 1e5') -| Selecting legend_lines=True plots lines only and colours them according to the sum of the start and end point divided by two. This can be a useful option when there are lots of trajectories. -| -| - diff --git a/docs/source/unstructured.rst b/docs/source/unstructured.rst index 9d3e425..8010ad5 100644 --- a/docs/source/unstructured.rst +++ b/docs/source/unstructured.rst @@ -1,4 +1,7 @@ +:orphan: + .. _unstructured: + Unstructured grids ****************** diff --git a/docs/source/user_defined.rst b/docs/source/user_defined.rst index cb41798..51afa50 100644 --- a/docs/source/user_defined.rst +++ b/docs/source/user_defined.rst @@ -1,4 +1,7 @@ +:orphan: + .. _user_defined: + User defined axes ***************** diff --git a/docs/source/user_guide.rst b/docs/source/user_guide.rst index cec47e3..1c3d3b9 100644 --- a/docs/source/user_guide.rst +++ b/docs/source/user_guide.rst @@ -1,3 +1,5 @@ +:orphan: + ****************** cf-plot user guide ****************** @@ -11,9 +13,9 @@ cf-plot user guide | contours_ - making contour plots | vectors_ - plotting vectors | multiple_ plots on a page and plot positioning -| trajectories_ - plotting trajectories +| trajectoriesUG_ - plotting trajectories | significance_ - plots -| graphs_ - making graphs +| graphsUG_ - making graphs | colour_ scales - using and changing colour scales | | appendixA_ - introduction to cf-python @@ -482,7 +484,7 @@ Plot spacing options are located in **cfp.gopen** | hspace=None - height reserved for white space between subplots - default=0.2 | | -|and color bar spacings in **cfp.cbar**. +| and color bar spacings in **cfp.cbar**. | | orientation - orientation 'horizontal' or 'vertical' | position - user specified colorbar position in normalised @@ -578,7 +580,7 @@ colour bars on the plot with different colour scales and contour levels. cfp.gclose() -.. _trajectories: +.. _trajectoriesUG: ^^^^^^^^^^^^ Trajectories @@ -656,7 +658,7 @@ A stipple plot is usually used to show areas of significance such as 95% or grea | -.. _graphs: +.. _graphsUG: ^^^^^^^^^^^ @@ -1143,7 +1145,7 @@ scale44 .. image:: images/colour_scales/scale44.png Colour bars ^^^^^^^^^^^ -Colour bars are often associated with filled colour contour plots and the options for the colour bar are described in the :ref:`cbar` . If the colour bar options are changed within the call to **cfp.con** then prepend colorbar_ to the appropriate colour bar option. cf-plot has used the American spelling for colorbar for compatability with the spelling and usage within the Matplotlib Python package. +Colour bars are often associated with filled colour contour plots and the options for the colour bar are described in the :ref:`cbar` . If the colour bar options are changed within the call to **cfp.con** then prepend ``colorbar`` to the appropriate colour bar option. cf-plot has used the American spelling for colorbar for compatability with the spelling and usage within the Matplotlib Python package. diff --git a/docs/source/vect.rst b/docs/source/vect.rst index 6d76ee6..33b56f3 100644 --- a/docs/source/vect.rst +++ b/docs/source/vect.rst @@ -1,4 +1,5 @@ .. _vect: + vect **** diff --git a/docs/source/vectors.rst b/docs/source/vectors.rst index e6c3ca3..0f7bfd4 100644 --- a/docs/source/vectors.rst +++ b/docs/source/vectors.rst @@ -1,4 +1,7 @@ +:orphan: + .. _vector: + Vector and stream plots *********************** diff --git a/docs/source/version3_changes.rst b/docs/source/version3_changes.rst index 515d362..ed146ff 100644 --- a/docs/source/version3_changes.rst +++ b/docs/source/version3_changes.rst @@ -1,3 +1,5 @@ +:orphan: + *********************************************** Python, cf-python and cf-plot version 3 changes *********************************************** diff --git a/docs/source/version_1.3.rst b/docs/source/version_1.3.rst index f8bc9fe..70b36f9 100644 --- a/docs/source/version_1.3.rst +++ b/docs/source/version_1.3.rst @@ -1,3 +1,5 @@ +:orphan: + .. _version_1.3: version 1.3 changes diff --git a/docs/source/version_1.5.rst b/docs/source/version_1.5.rst index 85aa4cc..f3e2725 100644 --- a/docs/source/version_1.5.rst +++ b/docs/source/version_1.5.rst @@ -1,4 +1,7 @@ +:orphan: + .. _version_1.5: + version 1.5 changes ******************* diff --git a/docs/source/version_1.6.rst b/docs/source/version_1.6.rst index 9eab6c4..47383cd 100644 --- a/docs/source/version_1.6.rst +++ b/docs/source/version_1.6.rst @@ -1,4 +1,7 @@ +:orphan: + .. _version_1.6: + version 1.6 changes ******************* diff --git a/docs/source/version_1.7.rst b/docs/source/version_1.7.rst index 13202a6..de15905 100644 --- a/docs/source/version_1.7.rst +++ b/docs/source/version_1.7.rst @@ -1,4 +1,7 @@ +:orphan: + .. _version_1.7: + version 1.7 changes ******************* diff --git a/docs/source/version_1.8.rst b/docs/source/version_1.8.rst index cb20f89..db906ea 100644 --- a/docs/source/version_1.8.rst +++ b/docs/source/version_1.8.rst @@ -1,4 +1,7 @@ +:orphan: + .. _version_1.8: + version 1.8 changes ******************* diff --git a/docs/source/version_1.9.rst b/docs/source/version_1.9.rst index 2771b85..dfd838d 100644 --- a/docs/source/version_1.9.rst +++ b/docs/source/version_1.9.rst @@ -1,4 +1,7 @@ +:orphan: + .. _version_1.9: + version 1.9 changes ******************* diff --git a/docs/source/version_2.0.rst b/docs/source/version_2.0.rst index 16454af..e084845 100644 --- a/docs/source/version_2.0.rst +++ b/docs/source/version_2.0.rst @@ -1,4 +1,7 @@ +:orphan: + .. _version_2.0: + version 2.0 changes ******************* diff --git a/docs/source/version_2.1.rst b/docs/source/version_2.1.rst index 1291792..71f3e26 100644 --- a/docs/source/version_2.1.rst +++ b/docs/source/version_2.1.rst @@ -1,4 +1,7 @@ +:orphan: + .. _version_2.1: + version 2.1 changes ******************* @@ -49,8 +52,7 @@ to revert to the previous behaviour. .. image:: images/scale1_original.png :scale: 52% - - +.. comment break to prevent indent below stopping image from rendering :: @@ -94,7 +96,7 @@ Lambert conformal projections can now be cropped as in the following code: .. image:: images/cm.png :scale: 52% - +.. comment break to prevent indent below stopping image from rendering :: @@ -157,9 +159,10 @@ A new colour scale was added - brown to blue - BrBG. -.. image:: images/colourscales/BrBG.png +.. image:: images/colour_scales/BrBG.png :scale: 52% +.. comment break to prevent indent below stopping image from rendering :: diff --git a/docs/source/version_2.2.rst b/docs/source/version_2.2.rst index ec6e86d..57527cd 100644 --- a/docs/source/version_2.2.rst +++ b/docs/source/version_2.2.rst @@ -1,4 +1,7 @@ +:orphan: + .. _version_2.2: + version 2.2 changes ******************* diff --git a/docs/source/version_2.3.rst b/docs/source/version_2.3.rst index af17ed6..32d5e22 100644 --- a/docs/source/version_2.3.rst +++ b/docs/source/version_2.3.rst @@ -1,4 +1,7 @@ +:orphan: + .. _version_2.3: + version 2.3 changes ******************* diff --git a/docs/source/version_2.4.rst b/docs/source/version_2.4.rst index 24d7a90..a35c572 100644 --- a/docs/source/version_2.4.rst +++ b/docs/source/version_2.4.rst @@ -1,4 +1,7 @@ +:orphan: + .. _version_2.4: + version 2.4 changes ******************* diff --git a/docs/source/version_3.0.rst b/docs/source/version_3.0.rst index 613824b..6d1e6a7 100644 --- a/docs/source/version_3.0.rst +++ b/docs/source/version_3.0.rst @@ -1,4 +1,7 @@ +:orphan: + .. _version_3.0: + version 3.0 changes ******************* diff --git a/docs/source/version_3.1.rst b/docs/source/version_3.1.rst index 99153ba..010b3df 100644 --- a/docs/source/version_3.1.rst +++ b/docs/source/version_3.1.rst @@ -1,4 +1,7 @@ +:orphan: + .. _version_3.1: + version 3.1 changes ******************* @@ -89,7 +92,7 @@ cf-python 3.8.0. The longer form always works and so this has been adopted. 10. cfp.gpos(1) causes stray box lines -===================================== +====================================== When making multiple plots on a page calling cfp.gpos(1) causes stray box lines to be added to the first plot. @@ -215,7 +218,7 @@ and another that isn't recogised as one of these. 19. cfp.con - improved Z axis detection -====================================== +======================================= The cf-plot find_dim_names routine was modified to use the cf-python get_data_axes method leading to more reliable Z axis detection when multiple Z axes are defined in the field. diff --git a/docs/source/version_3.2.rst b/docs/source/version_3.2.rst index 9cda03b..3421da0 100644 --- a/docs/source/version_3.2.rst +++ b/docs/source/version_3.2.rst @@ -1,4 +1,7 @@ +:orphan: + .. _version_3.2: + version 3.2 changes ******************* @@ -179,7 +182,7 @@ An error occured if a cell_method had no associated axis. A check was put in pl 14. cfp.con - ugrid keyword changed to irregular -=============================================== +================================================ In cfp.con the ugrid keyword was changed to irregular as this is more appropriate. diff --git a/docs/source/version_3.3.rst b/docs/source/version_3.3.rst index 0432f99..d016c4c 100644 --- a/docs/source/version_3.3.rst +++ b/docs/source/version_3.3.rst @@ -1,4 +1,7 @@ +:orphan: + .. _version_3.3: + version 3.3 changes ******************* diff --git a/docs/source/versions.rst b/docs/source/versions.rst index c33546b..2e49d2d 100644 --- a/docs/source/versions.rst +++ b/docs/source/versions.rst @@ -1,3 +1,5 @@ +:orphan: + Planned releases **************** diff --git a/docs/source/wrf.rst b/docs/source/wrf.rst index 9dc3afd..3ff85f4 100644 --- a/docs/source/wrf.rst +++ b/docs/source/wrf.rst @@ -1,4 +1,7 @@ +:orphan: + .. _wrf: + WRF data ********