1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
|
# -*- coding: utf-8 -*-
"""
Override sphinx_gallery's treatment of groups (folders) with cartopy's
``__tags__`` semantics. This is tightly bound to the sphinx_gallery
implementation, hence the explicit version checking.
This code was modified from sphinx-gallery:
Copyright (c) 2015, Óscar Nájera
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of sphinx-gallery nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
"""
from collections import OrderedDict, defaultdict
import os.path
import shutil
import tempfile
import textwrap
import sphinx_gallery
if sphinx_gallery.__version__ not in ['0.2.0']: # noqa: E402
raise RuntimeError('not tested with this version of sphinx_gallery ({}). '
'Please modify this check, and validate sphinx_gallery'
' behaves as expected.'
''.format(sphinx_gallery.__version__))
import sphinx_gallery.gen_gallery
import sphinx_gallery.gen_rst
from sphinx_gallery.gen_rst import (
write_backreferences, _thumbnail_div,
generate_file_rst, sphinx_compatibility)
GALLERY_HEADER = textwrap.dedent("""
Cartopy Gallery
---------------
The following visual examples demonstrate some of the functionality of
Cartopy, particularly its matplotlib interface.
For a structured introduction to cartopy, including some of these
examples, see :ref:`getting-started-with-cartopy`.
""")
def example_groups(src_dir):
"""Return a dictionary of {tag: [example filenames]} for the given dir."""
sorted_listdir = [fname for fname in sorted(os.listdir(src_dir))
if fname.endswith('.py') and not fname.startswith('_')]
tagged_examples = defaultdict(list)
for fname in sorted_listdir:
fpath = os.path.join(src_dir, fname)
with open(fpath, 'r') as fh:
for line in fh:
# Crudely extract the __tags__ line.
if line.startswith('__tags__ = '):
exec(line.strip(), locals(), globals())
for tag in __tags__: # noqa:
tagged_examples[tag].append(fname)
break
else:
tagged_examples['Miscellanea'].append(fname)
return tagged_examples
def order_examples(tagged_examples):
"""Order the tags and their examples."""
preferred_tag_order = ['Introductory',
'Lines and polygons',
'Scalar data',
'Vector data',
'Web services']
def sort_key(item):
tag = item[0]
try:
index = preferred_tag_order.index(tag)
except ValueError:
index = len(preferred_tag_order) + 1
return (index, tag.lower())
sorted_items = sorted(tagged_examples.items(), key=sort_key)
return OrderedDict(sorted_items)
def write_example(src_fpath, target_dir):
target_fpath = os.path.join(target_dir, os.path.basename(src_fpath))
with open(src_fpath, 'r') as fh:
with open(target_fpath, 'w') as fh_out:
for line in fh:
# Crudely remove the __tags__ line.
if line.startswith('__tags__ = '):
continue
fh_out.write(line)
def generate_dir_rst(src_dir, target_dir, gallery_conf, seen_backrefs):
"""Generate the gallery reStructuredText for an example directory"""
fhindex = GALLERY_HEADER
if not os.path.exists(target_dir):
os.makedirs(target_dir)
tagged_examples = example_groups(src_dir)
tagged_examples = order_examples(tagged_examples)
computation_times = []
build_target_dir = os.path.relpath(target_dir, gallery_conf['src_dir'])
seen = set()
tmp_dir = tempfile.mkdtemp()
for tag, examples in tagged_examples.items():
sorted_listdir = sorted(
examples,
key=gallery_conf['within_subsection_order'](src_dir))
entries_text = []
iterator = sphinx_compatibility.status_iterator(
sorted_listdir,
'Generating gallery for %s ' % tag,
length=len(sorted_listdir))
for fname in iterator:
write_example(os.path.join(src_dir, fname), tmp_dir)
intro, time_elapsed = generate_file_rst(
fname, target_dir, tmp_dir, gallery_conf)
if fname not in seen:
seen.add(fname)
computation_times.append((time_elapsed, fname))
this_entry = _thumbnail_div(build_target_dir, fname, intro) + textwrap.dedent("""
.. toctree::
:hidden:
/%s
""") % os.path.join(build_target_dir, fname[:-3]).replace(os.sep, '/') # noqa: E501
entries_text.append(this_entry)
if gallery_conf['backreferences_dir']:
write_backreferences(seen_backrefs, gallery_conf,
target_dir, fname, intro)
fhindex += textwrap.dedent("""
{tag}
{tag_underline}
.. container:: gallery_images
""".format(tag=tag, tag_underline='-' * len(tag)))
for entry_text in entries_text:
fhindex += '\n '.join(entry_text.split('\n'))
# clear at the end of the section
fhindex += """.. raw:: html\n
<div style='clear:both'></div>\n\n"""
# Tidy up the temp directory
shutil.rmtree(tmp_dir)
return fhindex, computation_times
# Monkey-patch sphinx_gallery to handle cartopy's example format.
sphinx_gallery.gen_rst.generate_dir_rst = generate_dir_rst
sphinx_gallery.gen_gallery.generate_dir_rst = generate_dir_rst
def setup(app):
pass
|
