Skip to content

Commit

Permalink
Merge pull request #33 from sadielbartholomew/add-docs-excluding-larg…
Browse files Browse the repository at this point in the history
…e-files

Add full documentation excluding unreferenced data files
  • Loading branch information
sadielbartholomew authored Mar 8, 2024
2 parents b82ba96 + 397f81e commit 4eb2efa
Show file tree
Hide file tree
Showing 835 changed files with 221,387 additions and 3 deletions.
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

### Overview

![cf-plot example gallery of plots](docs/media/cf_gallery_image.png "Examples Gallery of plots made with the cf-plot library")
![cf-plot example gallery of plots](docs/source/images/cf_gallery_image.png "Examples Gallery of plots made with the cf-plot library")

**cf-plot allows you to produce and customise publication-quality contour,
vector, line and more plots with the power of Python,
Expand Down Expand Up @@ -54,8 +54,7 @@ See [the cf-plot homepage](http://ajheaps.github.io/cf-plot)
To install cf-plot with its required dependencies, you can use `pip`:

```bash
pip install cf-python
pip install cf-plot
pip install cf-python cf-plot
```

or you can use `conda` (or similar package managers such
Expand Down
Empty file added docs/.nojekyll
Empty file.
4 changes: 4 additions & 0 deletions docs/build/.buildinfo
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 0a739ebdc2d63ea1871255cde05d846d
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file added docs/build/_images/3gauss.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/3saw.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/BkBlAqGrYeOrReViWh200.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/BlAqGrYeOrRe.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/BlAqGrYeOrReVi200.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/BlGrYeOrReVi200.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/BlRe.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/BlWhRe.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/BlueDarkOrange18.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/BlueDarkRed18.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/BlueGreen14.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/BlueRed.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/BlueRedGray.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/BlueWhiteOrangeRed.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/BlueYellowRed.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/BrBG.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/BrownBlue12.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/Cat12.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/GHRSST_anomaly.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/GrayWhiteGray.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/GreenMagenta16.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/GreenYellow.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/OceanLakeLandSnow.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/StepSeq25.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/ViBlGrWhYeOrRe.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/WhBlGrYeRe.png
Binary file added docs/build/_images/WhBlReWh.png
Binary file added docs/build/_images/WhViBlGrYeOrRe.png
Binary file added docs/build/_images/WhViBlGrYeOrReWh.png
Binary file added docs/build/_images/WhiteBlue.png
Binary file added docs/build/_images/WhiteBlueGreenYellowRed.png
Binary file added docs/build/_images/WhiteGreen.png
Binary file added docs/build/_images/WhiteYellowOrangeRed.png
Binary file added docs/build/_images/advanced1.png
Binary file added docs/build/_images/advanced2.png
Binary file added docs/build/_images/advanced3.png
Binary file added docs/build/_images/advanced4.png
Binary file added docs/build/_images/advanced5.png
Binary file added docs/build/_images/advanced6.png
Binary file added docs/build/_images/advanced_shapefile.png
Binary file added docs/build/_images/advanced_transect.png
Binary file added docs/build/_images/amwg.png
Binary file added docs/build/_images/amwg256.png
Binary file added docs/build/_images/amwg_blueyellowred.png
Binary file added docs/build/_images/arctic.png
Binary file added docs/build/_images/cbar.png
Binary file added docs/build/_images/cm.png
Binary file added docs/build/_images/cmp_b2r.png
Binary file added docs/build/_images/cmp_flux.png
Binary file added docs/build/_images/cmp_haxby.png
Binary file added docs/build/_images/cosam.png
Binary file added docs/build/_images/cosam12.png
Binary file added docs/build/_images/cs1.png
Binary file added docs/build/_images/cs2.png
Binary file added docs/build/_images/cs3.png
Binary file added docs/build/_images/cs4.png
Binary file added docs/build/_images/cscale.png
Binary file added docs/build/_images/data_fig1.png
Binary file added docs/build/_images/data_fig2.png
Binary file added docs/build/_images/data_fig3.png
Binary file added docs/build/_images/data_fig4.png
Binary file added docs/build/_images/data_fig5.png
Binary file added docs/build/_images/data_fig6.png
Binary file added docs/build/_images/data_incorrect1.png
Binary file added docs/build/_images/data_incorrect2.png
Binary file added docs/build/_images/detail.png
Binary file added docs/build/_images/extrema.png
Binary file added docs/build/_images/fig1.png
Binary file added docs/build/_images/fig10.png
Binary file added docs/build/_images/fig11.png
Binary file added docs/build/_images/fig12.png
Binary file added docs/build/_images/fig13.png
Binary file added docs/build/_images/fig14.png
Binary file added docs/build/_images/fig15.png
Binary file added docs/build/_images/fig16.png
Binary file added docs/build/_images/fig16b.png
Binary file added docs/build/_images/fig16c.png
Binary file added docs/build/_images/fig17.png
Binary file added docs/build/_images/fig18.png
Binary file added docs/build/_images/fig19.png
Binary file added docs/build/_images/fig19a.png
Binary file added docs/build/_images/fig19b.png
Binary file added docs/build/_images/fig2.png
Binary file added docs/build/_images/fig20.png
Binary file added docs/build/_images/fig20a.png
Binary file added docs/build/_images/fig21.png
Binary file added docs/build/_images/fig22.png
Binary file added docs/build/_images/fig23.png
Binary file added docs/build/_images/fig24.png
Binary file added docs/build/_images/fig25.png
Binary file added docs/build/_images/fig26.png
Binary file added docs/build/_images/fig27.png
Binary file added docs/build/_images/fig28.png
Binary file added docs/build/_images/fig29.png
Binary file added docs/build/_images/fig3.png
Binary file added docs/build/_images/fig30.png
Binary file added docs/build/_images/fig31.png
Binary file added docs/build/_images/fig32.png
Binary file added docs/build/_images/fig33.png
Binary file added docs/build/_images/fig34.png
Binary file added docs/build/_images/fig35.png
Binary file added docs/build/_images/fig36.png
Binary file added docs/build/_images/fig37.png
Binary file added docs/build/_images/fig38.png
Binary file added docs/build/_images/fig39.png
Binary file added docs/build/_images/fig4.png
Binary file added docs/build/_images/fig40.png
Binary file added docs/build/_images/fig41.png
Binary file added docs/build/_images/fig42.png
Binary file added docs/build/_images/fig42a.png
Binary file added docs/build/_images/fig43.png
Binary file added docs/build/_images/fig5.png
Binary file added docs/build/_images/fig6.png
Binary file added docs/build/_images/fig7.png
Binary file added docs/build/_images/fig8.png
Binary file added docs/build/_images/fig9.png
Binary file added docs/build/_images/gray.png
Binary file added docs/build/_images/guide1.png
Binary file added docs/build/_images/guide2.png
Binary file added docs/build/_images/guide3.png
Binary file added docs/build/_images/guide4.png
Binary file added docs/build/_images/guide5.png
Binary file added docs/build/_images/guide6.png
Binary file added docs/build/_images/guide7.png
Binary file added docs/build/_images/guide8.png
Binary file added docs/build/_images/helix.png
Binary file added docs/build/_images/helix1.png
Binary file added docs/build/_images/hotcold_18lev.png
Binary file added docs/build/_images/hotcolr_19lev.png
Binary file added docs/build/_images/hotres.png
Binary file added docs/build/_images/inferno.png
Binary file added docs/build/_images/magma.png
Binary file added docs/build/_images/matlab_hot.png
Binary file added docs/build/_images/matlab_hsv.png
Binary file added docs/build/_images/matlab_jet.png
Binary file added docs/build/_images/matlab_lines.png
Binary file added docs/build/_images/mch_default.png
Binary file added docs/build/_images/ncl_default.png
Binary file added docs/build/_images/ncview_default.png
Binary file added docs/build/_images/nrl_sirkes.png
Binary file added docs/build/_images/nrl_sirkes_nowhite.png
Binary file added docs/build/_images/orog.png
Binary file added docs/build/_images/os250kmetres.png
Binary file added docs/build/_images/parula.png
Binary file added docs/build/_images/perc2_9lev.png
Binary file added docs/build/_images/percent_11lev.png
Binary file added docs/build/_images/plasma.png
Binary file added docs/build/_images/posneg_1.png
Binary file added docs/build/_images/posneg_2.png
Binary file added docs/build/_images/prcp_1.png
Binary file added docs/build/_images/prcp_2.png
Binary file added docs/build/_images/prcp_3.png
Binary file added docs/build/_images/precip2_15lev.png
Binary file added docs/build/_images/precip2_17lev.png
Binary file added docs/build/_images/precip3_16lev.png
Binary file added docs/build/_images/precip4_11lev.png
Binary file added docs/build/_images/precip4_diff_19lev.png
Binary file added docs/build/_images/precip_11lev.png
Binary file added docs/build/_images/precip_diff_12lev.png
Binary file added docs/build/_images/precip_diff_1lev.png
Binary file added docs/build/_images/radar.png
Binary file added docs/build/_images/radar_1.png
Binary file added docs/build/_images/rainbow.png
Binary file added docs/build/_images/rainbow_gray.png
Binary file added docs/build/_images/rainbow_white.png
Binary file added docs/build/_images/rainbow_white_gray.png
Binary file added docs/build/_images/rh_19lev.png
Binary file added docs/build/_images/scale1.png
Binary file added docs/build/_images/scale10.png
Binary file added docs/build/_images/scale11.png
Binary file added docs/build/_images/scale12.png
Binary file added docs/build/_images/scale13.png
Binary file added docs/build/_images/scale14.png
Binary file added docs/build/_images/scale15.png
Binary file added docs/build/_images/scale16.png
Binary file added docs/build/_images/scale17.png
Binary file added docs/build/_images/scale18.png
Binary file added docs/build/_images/scale19.png
Binary file added docs/build/_images/scale1_new.png
Binary file added docs/build/_images/scale2.png
Binary file added docs/build/_images/scale20.png
Binary file added docs/build/_images/scale21.png
Binary file added docs/build/_images/scale22.png
Binary file added docs/build/_images/scale23.png
Binary file added docs/build/_images/scale24.png
Binary file added docs/build/_images/scale25.png
Binary file added docs/build/_images/scale26.png
Binary file added docs/build/_images/scale27.png
Binary file added docs/build/_images/scale28.png
Binary file added docs/build/_images/scale29.png
Binary file added docs/build/_images/scale3.png
Binary file added docs/build/_images/scale30.png
Binary file added docs/build/_images/scale31.png
Binary file added docs/build/_images/scale32.png
Binary file added docs/build/_images/scale33.png
Binary file added docs/build/_images/scale34.png
Binary file added docs/build/_images/scale35.png
Binary file added docs/build/_images/scale36.png
Binary file added docs/build/_images/scale37.png
Binary file added docs/build/_images/scale38.png
Binary file added docs/build/_images/scale39.png
Binary file added docs/build/_images/scale4.png
Binary file added docs/build/_images/scale40.png
Binary file added docs/build/_images/scale41.png
Binary file added docs/build/_images/scale42.png
Binary file added docs/build/_images/scale43.png
Binary file added docs/build/_images/scale44.png
Binary file added docs/build/_images/scale5.png
Binary file added docs/build/_images/scale6.png
Binary file added docs/build/_images/scale7.png
Binary file added docs/build/_images/scale8.png
Binary file added docs/build/_images/scale9.png
Binary file added docs/build/_images/seaice_1.png
Binary file added docs/build/_images/seaice_2.png
Binary file added docs/build/_images/so4_21.png
Binary file added docs/build/_images/spread_15lev.png
Binary file added docs/build/_images/sunshine_9lev.png
Binary file added docs/build/_images/sunshine_diff_12lev.png
Binary file added docs/build/_images/tbrAvg1.png
Binary file added docs/build/_images/tbrStd1.png
Binary file added docs/build/_images/tbrVar1.png
Binary file added docs/build/_images/tbr_240_300.png
Binary file added docs/build/_images/tbr_stdev_0_30.png
Binary file added docs/build/_images/tbr_var_0_500.png
Binary file added docs/build/_images/temp_19lev.png
Binary file added docs/build/_images/temp_diff_18lev.png
Binary file added docs/build/_images/temp_diff_1lev.png
Binary file added docs/build/_images/thelix.png
Binary file added docs/build/_images/time_axis_labelling.png
Binary file added docs/build/_images/topo_15lev.png
Binary file added docs/build/_images/us01.png
Binary file added docs/build/_images/us02.png
Binary file added docs/build/_images/us03.png
Binary file added docs/build/_images/us04.png
Binary file added docs/build/_images/us05.png
Binary file added docs/build/_images/us06.png
Binary file added docs/build/_images/viridis.png
Binary file added docs/build/_images/wgne15.png
Binary file added docs/build/_images/wh_bl_gr_ye_re.png
Binary file added docs/build/_images/wiki_1_0_2.png
Binary file added docs/build/_images/wiki_1_0_3.png
Binary file added docs/build/_images/wiki_2_0.png
Binary file added docs/build/_images/wiki_2_0_reduced.png
Binary file added docs/build/_images/wind_17lev.png
Binary file added docs/build/_images/wxpEnIR.png
10,762 changes: 10,762 additions & 0 deletions docs/build/_modules/cfplot.html

Large diffs are not rendered by default.

9,154 changes: 9,154 additions & 0 deletions docs/build/_modules/cfplot/cfplot.html

Large diffs are not rendered by default.

78 changes: 78 additions & 0 deletions docs/build/_modules/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
<!DOCTYPE html>

<html lang="en" data-content_root="../">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Overview: module code &#8212; cf-plot 3.3.0 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../_static/classic.css?v=97decc96" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />

<script src="../_static/documentation_options.js?v=3eb8911e"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>

<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="nav-item nav-item-0"><a href="../index.html">cf-plot 3.3.0 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Overview: module code</a></li>
</ul>
</div>

<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">

<h1>All modules for which code is available</h1>
<ul><li><a href="cfplot.html">cfplot</a></li>
</ul>

<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">

<h3><a href="index.html">Homepage</a><p></h3>
<h5><a href="gallery.html">Gallery</a><p></h5>
<h5><a href="user_guide.html">User Guide</a><p></h5>
<h5><a href="training.html">Training material</a><p></h5>
<h5><a href="routines.html">Routines</a><p></h5>
<h5><a href="internal_routines.html">Routines - internal</a><p></h5>
<h5><a href="advanced.html">Advanced Use</a><p></h5>
<h5><a href="versions.html">Versions</a><p></h5>
<h5><a href="issues.html">Issues</a><p></h5>
<h5><a href="download.html">Download/Install</a><p></h5>
<h5><a href="license.html">License</a><p></h5>
<h5><a href="older_documentation.html">Older documentation</a><p></h5>
<h5><a href="search.html">Search</a><p></h5>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="nav-item nav-item-0"><a href="../index.html">cf-plot 3.3.0 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Overview: module code</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2024, Sadie Bartholomew.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
</div>
</body>
</html>
4 changes: 4 additions & 0 deletions docs/build/_sources/add_cyclic.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
add_cyclic
**********

.. autofunction:: cfplot.add_cyclic
Loading

0 comments on commit 4eb2efa

Please sign in to comment.