Skip to content
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.

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

Docs: fix RST formatting/linkage issues resulting in build warnings #40

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Binary file added docs/build/_images/cf_gallery_image.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/build/_images/cm.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/build/_images/scale1_original.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions docs/build/_sources/advanced.rst.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
:orphan:

.. _advanced:

Advanced Use
************

Expand Down
1 change: 1 addition & 0 deletions docs/build/_sources/cbar.rst.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
.. _cbar:

cbar
****

Expand Down
3 changes: 3 additions & 0 deletions docs/build/_sources/colour_scales.rst.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
:orphan:

.. _colour_scales:

Colour scales
*************

Expand Down
1 change: 1 addition & 0 deletions docs/build/_sources/con.rst.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
.. _con:

con
***

Expand Down
1 change: 1 addition & 0 deletions docs/build/_sources/cscale.rst.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
.. _cscale:

cscale
******

Expand Down
3 changes: 3 additions & 0 deletions docs/build/_sources/cylindrical.rst.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
:orphan:

.. _cylindrical:

Cylindrical projection
**********************

Expand Down
3 changes: 3 additions & 0 deletions docs/build/_sources/download.rst.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
:orphan:

.. _download:

Download/Install
****************

Expand Down
4 changes: 3 additions & 1 deletion docs/build/_sources/gallery.rst.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

cf-plot gallery
===============

Expand Down Expand Up @@ -35,7 +37,7 @@ cf-plot gallery
:target: colour_scales.html

:ref:`Vector plots <vector>` |
:ref:`Stipple plots <stipple>` |
:ref:`Stipple plots <stippleplots>` |
:ref:`Multiple plots on a page<multiple_plots>` |
:ref:`Colour scales <colour_scales>`

Expand Down
1 change: 1 addition & 0 deletions docs/build/_sources/gclose.rst.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
.. _gclose:

gclose
******

Expand Down
1 change: 1 addition & 0 deletions docs/build/_sources/gopen.rst.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
.. _gopen:

gopen
*****

Expand Down
1 change: 1 addition & 0 deletions docs/build/_sources/gpos.rst.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
.. _gpos:

gpos
****

Expand Down
3 changes: 3 additions & 0 deletions docs/build/_sources/graphs.rst.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
:orphan:

.. _graphs:

Graphs
******

Expand Down
1 change: 1 addition & 0 deletions docs/build/_sources/gset.rst.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
.. _gset:

gset
****

Expand Down
5 changes: 4 additions & 1 deletion docs/build/_sources/hovmuller.rst.txt
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
:orphan:

.. _hovmuller:

Hovmuller plots
***************

Example 10 - latitude-time
-------------------------
--------------------------

.. image:: images/fig10.png
:scale: 52%
Expand Down
2 changes: 2 additions & 0 deletions docs/build/_sources/internal_routines.rst.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

Internal routines
*****************

Expand Down
2 changes: 2 additions & 0 deletions docs/build/_sources/issues.rst.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

cf-plot issues
**************

Expand Down
1 change: 1 addition & 0 deletions docs/build/_sources/levs.rst.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
.. _levs:

levs
****

Expand Down
2 changes: 2 additions & 0 deletions docs/build/_sources/license.rst.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

License
*******

Expand Down
1 change: 1 addition & 0 deletions docs/build/_sources/lineplot.rst.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
.. _lineplot:

lineplot
********

Expand Down
1 change: 1 addition & 0 deletions docs/build/_sources/mapset.rst.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
.. _mapset:

mapset
******

Expand Down
3 changes: 3 additions & 0 deletions docs/build/_sources/multiple_plots.rst.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
:orphan:

.. _multiple_plots:

Multiple plots
**************

Expand Down
1 change: 1 addition & 0 deletions docs/build/_sources/older_documentation.rst.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
:orphan:

Older documentation
*******************
Expand Down
3 changes: 3 additions & 0 deletions docs/build/_sources/polar.rst.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
:orphan:

.. _polar:

Polar stereographic projection
******************************

Expand Down
3 changes: 3 additions & 0 deletions docs/build/_sources/pressure.rst.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
:orphan:

.. _pressure:

Latitude / longitude - pressure
*******************************

Expand Down
3 changes: 3 additions & 0 deletions docs/build/_sources/projections.rst.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
:orphan:

.. _projections:

Projections in cf-plot
**********************

Expand Down
1 change: 1 addition & 0 deletions docs/build/_sources/reset.rst.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
.. _reset:

reset
*****

Expand Down
6 changes: 5 additions & 1 deletion docs/build/_sources/rotated_pole.rst.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
:orphan:

.. _rotated_pole:

Rotated pole plots
******************

Expand Down Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions docs/build/_sources/routines.rst.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

Routines
********

Expand Down
1 change: 1 addition & 0 deletions docs/build/_sources/setvars.rst.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
.. _setvars:

setvars
*******

Expand Down
1 change: 1 addition & 0 deletions docs/build/_sources/stipple.rst.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
.. _stipple:

stipple
*******

Expand Down
5 changes: 4 additions & 1 deletion docs/build/_sources/stipple_plots.rst.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
.. _stipple:
:orphan:

.. _stippleplots:

Stipple plots
*************

Expand Down
5 changes: 5 additions & 0 deletions docs/build/_sources/timeaxis.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
timeaxis
********

.. autofunction:: cfplot.timeaxis

3 changes: 3 additions & 0 deletions docs/build/_sources/training.rst.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
:orphan:

.. _training:

Training material
*****************

Expand Down
1 change: 1 addition & 0 deletions docs/build/_sources/traj.rst.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
.. _traj:

traj
****

Expand Down
7 changes: 3 additions & 4 deletions docs/build/_sources/trajectories.rst.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
:orphan:

.. _trajectories:

Trajectories
************

Expand Down Expand Up @@ -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.

|
|

3 changes: 3 additions & 0 deletions docs/build/_sources/unstructured.rst.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
:orphan:

.. _unstructured:

Unstructured grids
******************

Expand Down
3 changes: 3 additions & 0 deletions docs/build/_sources/user_defined.rst.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
:orphan:

.. _user_defined:

User defined axes
*****************

Expand Down
14 changes: 8 additions & 6 deletions docs/build/_sources/user_guide.rst.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

******************
cf-plot user guide
******************
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -578,7 +580,7 @@ colour bars on the plot with different colour scales and contour levels.
cfp.gclose()


.. _trajectories:
.. _trajectoriesUG:

^^^^^^^^^^^^
Trajectories
Expand Down Expand Up @@ -656,7 +658,7 @@ A stipple plot is usually used to show areas of significance such as 95% or grea
|


.. _graphs:
.. _graphsUG:


^^^^^^^^^^^
Expand Down Expand Up @@ -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<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<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.



Expand Down
1 change: 1 addition & 0 deletions docs/build/_sources/vect.rst.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
.. _vect:

vect
****

Expand Down
3 changes: 3 additions & 0 deletions docs/build/_sources/vectors.rst.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
:orphan:

.. _vector:

Vector and stream plots
***********************

Expand Down
2 changes: 2 additions & 0 deletions docs/build/_sources/version3_changes.rst.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

***********************************************
Python, cf-python and cf-plot version 3 changes
***********************************************
Expand Down
2 changes: 2 additions & 0 deletions docs/build/_sources/version_1.3.rst.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _version_1.3:

version 1.3 changes
Expand Down
3 changes: 3 additions & 0 deletions docs/build/_sources/version_1.5.rst.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
:orphan:

.. _version_1.5:

version 1.5 changes
*******************

Expand Down
3 changes: 3 additions & 0 deletions docs/build/_sources/version_1.6.rst.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
:orphan:

.. _version_1.6:

version 1.6 changes
*******************

Expand Down
3 changes: 3 additions & 0 deletions docs/build/_sources/version_1.7.rst.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
:orphan:

.. _version_1.7:

version 1.7 changes
*******************

Expand Down
Loading