adding auto-linking

SciTools · Jun 29, 2017 · b621060 · b621060
1 parent 9617fc8
commit b621060
Show file tree

Hide file tree

Showing 11 changed files with 72 additions and 10 deletions.
diff --git a/docs/doc-requirements.txt b/docs/doc-requirements.txt
@@ -1,3 +1,4 @@
 netCDF4
 iris
 cf_units
+sphinx-gallery
diff --git a/docs/source/_templates/automodule.rst b/docs/source/_templates/automodule.rst
@@ -0,0 +1,35 @@
+{{ fullname | escape | underline}}
+
+
+.. automodule:: {{ fullname }}
+   :no-members:
+   :no-inherited-members:
+
+{% block classes %}
+{% if classes %}
+
+Classes
+-------
+
+.. autosummary:: 
+   :template: autosummary.rst
+   :toctree:
+{% for item in classes %}{% if item not in ['zip', 'map', 'reduce'] %}
+   {{ item }}{% endif %}{% endfor %}
+{% endif %}
+{% endblock %}
+
+{% block functions %}
+{% if functions %}
+
+Functions
+---------
+
+.. autosummary:: 
+   :template: autosummary.rst
+   :toctree:
+
+{% for item in functions %}{% if item not in ['zip', 'map', 'reduce'] %}
+   {{ item }}{% endif %}{% endfor %}
+{% endif %}
+{% endblock %}
diff --git a/docs/source/_templates/autosummary.rst b/docs/source/_templates/autosummary.rst
@@ -0,0 +1,16 @@
+{{ fullname | escape | underline}}
+
+
+.. currentmodule:: {{ module }}
+
+.. auto{{ objtype }}:: {{ objname }}
+
+{% if objtype in ['class', 'method', 'function'] %}
+
+.. include:: {{module}}.{{objname}}.examples
+
+.. raw:: html
+
+    <div class="clearer"></div>
+
+{% endif %}
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -92,12 +92,13 @@
 # Sphinx gallery configuration
 sphinx_gallery_conf = {
     'examples_dirs': ['../../lib/cartopy/examples'],
-    'filename_pattern': '^((?!sgskip).)*$',
+    'filename_pattern': '^((?!sgskip).)*$|^((?!__init__.py).)*$',
     'gallery_dirs': ['gallery'],
     'doc_module': ('cartopy'),
     'reference_url': {'matplotlib': 'http://matplotlib.org',
                       'numpy': 'http://docs.scipy.org/doc/numpy/reference',
-                      'scipy': 'http://docs.scipy.org/doc/scipy/reference'},
+                      'scipy': 'http://docs.scipy.org/doc/scipy/reference',
+                      'cartopy': None},
     'backreferences_dir': 'api/_as_gen',
 }
 
@@ -336,8 +337,8 @@
 
 # Example configuration for intersphinx: refer to the Python standard library.
 intersphinx_mapping = {'python': ('https://docs.python.org/3', None),
-                       'matplotlib': ('http://matplotlib.org', None),
-                       'shapely': ('http://toblerity.org/shapely', None),}
+                       'matplotlib': ('https://matplotlib.org', None),
+                       'shapely': ('https://toblerity.org/shapely', None),}
 
 
 

diff --git a/lib/cartopy/examples/README.txt b/lib/cartopy/examples/README.txt
@@ -1,7 +1,7 @@
-CartoPy Gallery
+Cartopy Gallery
 ---------------
 
-The following examples show off the functionality of CartoPy. They
+The following examples show off the functionality of Cartopy. They
 illustrate the kinds of things you can do with this library. For
-more examples, tutorials, and guides on how to use CartoPy, see
+more examples, tutorials, and guides on how to use Cartopy, see
 the :ref:`getting started <getting-started>` section.
diff --git a/lib/cartopy/examples/__init__.py b/lib/cartopy/examples/__init__.py
diff --git a/lib/cartopy/examples/lines_and_polygons/always_circular_stereo.py b/lib/cartopy/examples/lines_and_polygons/always_circular_stereo.py
@@ -1,7 +1,8 @@
 """
-Always Circular Stereo
+Keep Boundary Circular
 ----------------------
 
+Setting the boundary of an image to be circular.
 """
 import matplotlib.path as mpath
 import matplotlib.pyplot as plt

diff --git a/lib/cartopy/examples/miscellanea/un_flag.py b/lib/cartopy/examples/miscellanea/un_flag.py
@@ -1,5 +1,5 @@
 """
-Un Flag
+UN Flag
 -------
 
 """

diff --git a/lib/cartopy/examples/scalar_data/eyja_volcano.py b/lib/cartopy/examples/scalar_data/eyja_volcano.py
@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 """
 Map tile acquisition
 --------------------
@@ -7,8 +8,10 @@
 into a single image and displayed in the cartopy GeoAxes.
 
 .. _examples-eyja_volcano:
+
+Grabbing the map tiles
+======================
 """
-# -*- coding: utf-8 -*-
 import matplotlib.pyplot as plt
 from matplotlib.transforms import offset_copy
 

diff --git a/...mples/scalar_data/geostationary_sgskip.py → ...opy/examples/scalar_data/geostationary.py b/...mples/scalar_data/geostationary_sgskip.py → ...opy/examples/scalar_data/geostationary.py
@@ -52,7 +52,9 @@ def main():
     ax = fig.add_subplot(1, 1, 1, projection=ccrs.Miller())
     ax.coastlines()
     ax.set_global()
+    print('Retrieving image...')
     img, crs, extent, origin = geos_image()
+    print('Projecting and plotting image (this may take a while)...')
     ax.imshow(img, transform=crs, extent=extent, origin=origin, cmap='gray')
     plt.show()
 

diff --git a/lib/cartopy/examples/web_services/wmts.py b/lib/cartopy/examples/web_services/wmts.py
@@ -14,6 +14,9 @@
 and Atmospheric Administration (NOAA).
 
 .. _examples-wmts:
+
+Downloading and plotting tiles
+==============================
 """
 
 import cartopy.crs as ccrs