Skip to content

Commit a2322e6

Browse files
tacaswelltacaswell
committed
DOC: make sphinx play nice
1 parent 81841fc commit a2322e6

File tree

9 files changed

+892
-123
lines changed

9 files changed

+892
-123
lines changed

‎.gitignore‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ cover/
5454

5555
# Sphinx documentation
5656
docs/_build/
57+
doc/source/generated/
5758

5859
#mac
5960
.DS_Store
@@ -78,4 +79,4 @@ docs/_build/
7879
doc/resource/api/generated/
7980

8081
# ipython caches
81-
.ipynb_checkpoints/
82+
.ipynb_checkpoints/

‎cycler.py‎

Lines changed: 61 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,23 @@ def _process_keys(left, right):
3030

3131
class Cycler(object):
3232
"""
33-
A class to handle cycling multiple artist properties.
33+
Composable cycles
3434
35-
This class has two compositions methods '+' for 'inner'
36-
products of the cycles and '*' for outer products of the
37-
cycles.
35+
This class has compositions methods:
36+
37+
``+``
38+
for 'inner' products (zip)
39+
40+
``+=``
41+
in-place ``+``
42+
43+
``*``
44+
for outer products (itertools.product) and integer multiplication
45+
46+
``*=``
47+
in-place ``*``
48+
49+
and supports basic slicing via ``[]``
3850
3951
Parameters
4052
----------
@@ -49,13 +61,20 @@ class Cycler(object):
4961
5062
"""
5163
def __init__(self, left, right=None, op=None):
64+
"""Semi-private init
65+
66+
Do not use this directly, use `cycler` function instead.
67+
"""
5268
self._keys = _process_keys(left, right)
5369
self._left = copy.copy(left)
5470
self._right = copy.copy(right)
5571
self._op = op
5672

5773
@property
5874
def keys(self):
75+
"""
76+
The keys this Cycler knows about
77+
"""
5978
return set(self._keys)
6079

6180
def _compose(self):
@@ -110,12 +129,29 @@ def __iter__(self):
110129
return self._compose()
111130

112131
def __add__(self, other):
132+
"""
133+
Pair-wise combine two equal length cycles (zip)
134+
135+
Parameters
136+
----------
137+
other : Cycler
138+
The second Cycler
139+
"""
113140
if len(self) != len(other):
114141
raise ValueError("Can only add equal length cycles, "
115142
"not {0} and {1}".format(len(self), len(other)))
116143
return Cycler(self, other, zip)
117144

118145
def __mul__(self, other):
146+
"""
147+
Outer product of two cycles (`itertools.product`) or integer
148+
multiplication.
149+
150+
Parameters
151+
----------
152+
other : Cycler or int
153+
The second Cycler or integer
154+
"""
119155
if isinstance(other, Cycler):
120156
return Cycler(self, other, product)
121157
elif isinstance(other, int):
@@ -137,6 +173,14 @@ def __len__(self):
137173
return op_dict[self._op](l_len, r_len)
138174

139175
def __iadd__(self, other):
176+
"""
177+
In-place pair-wise combine two equal length cycles (zip)
178+
179+
Parameters
180+
----------
181+
other : Cycler
182+
The second Cycler
183+
"""
140184
old_self = copy.copy(self)
141185
self._keys = _process_keys(old_self, other)
142186
self._left = old_self
@@ -145,6 +189,15 @@ def __iadd__(self, other):
145189
return self
146190

147191
def __imul__(self, other):
192+
"""
193+
In-place outer product of two cycles (`itertools.product`)
194+
195+
Parameters
196+
----------
197+
other : Cycler
198+
The second Cycler
199+
"""
200+
148201
old_self = copy.copy(self)
149202
self._keys = _process_keys(old_self, other)
150203
self._left = old_self
@@ -203,15 +256,14 @@ def _transpose(self):
203256
return out
204257

205258
def simplify(self):
206-
"""
207-
Simplify the Cycler and return as a composition only
208-
sums (no multiplications)
259+
"""Simplify the Cycler
260+
261+
Returned as a composition using only sums (no multiplications)
209262
210263
Returns
211264
-------
212265
simple : Cycler
213-
An equivalent cycler using only summation
214-
"""
266+
An equivalent cycler using only summation"""
215267
# TODO: sort out if it is worth the effort to make sure this is
216268
# balanced. Currently it is is
217269
# (((a + b) + c) + d) vs

‎doc/Makefile‎

Lines changed: 177 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,177 @@
1+
# Makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line.
5+
SPHINXOPTS =
6+
SPHINXBUILD = sphinx-build
7+
PAPER =
8+
BUILDDIR = build
9+
10+
# User-friendly check for sphinx-build
11+
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
12+
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
13+
endif
14+
15+
# Internal variables.
16+
PAPEROPT_a4 = -D latex_paper_size=a4
17+
PAPEROPT_letter = -D latex_paper_size=letter
18+
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
19+
# the i18n builder cannot share the environment and doctrees with the others
20+
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
21+
22+
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
23+
24+
help:
25+
@echo "Please use \`make <target>' where <target> is one of"
26+
@echo " html to make standalone HTML files"
27+
@echo " dirhtml to make HTML files named index.html in directories"
28+
@echo " singlehtml to make a single large HTML file"
29+
@echo " pickle to make pickle files"
30+
@echo " json to make JSON files"
31+
@echo " htmlhelp to make HTML files and a HTML help project"
32+
@echo " qthelp to make HTML files and a qthelp project"
33+
@echo " devhelp to make HTML files and a Devhelp project"
34+
@echo " epub to make an epub"
35+
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
36+
@echo " latexpdf to make LaTeX files and run them through pdflatex"
37+
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
38+
@echo " text to make text files"
39+
@echo " man to make manual pages"
40+
@echo " texinfo to make Texinfo files"
41+
@echo " info to make Texinfo files and run them through makeinfo"
42+
@echo " gettext to make PO message catalogs"
43+
@echo " changes to make an overview of all changed/added/deprecated items"
44+
@echo " xml to make Docutils-native XML files"
45+
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
46+
@echo " linkcheck to check all external links for integrity"
47+
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
48+
49+
clean:
50+
rm -rf $(BUILDDIR)/*
51+
52+
html:
53+
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
54+
@echo
55+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
56+
57+
dirhtml:
58+
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
59+
@echo
60+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
61+
62+
singlehtml:
63+
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
64+
@echo
65+
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
66+
67+
pickle:
68+
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
69+
@echo
70+
@echo "Build finished; now you can process the pickle files."
71+
72+
json:
73+
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
74+
@echo
75+
@echo "Build finished; now you can process the JSON files."
76+
77+
htmlhelp:
78+
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
79+
@echo
80+
@echo "Build finished; now you can run HTML Help Workshop with the" \
81+
".hhp project file in $(BUILDDIR)/htmlhelp."
82+
83+
qthelp:
84+
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
85+
@echo
86+
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
87+
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
88+
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/cycler.qhcp"
89+
@echo "To view the help file:"
90+
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/cycler.qhc"
91+
92+
devhelp:
93+
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
94+
@echo
95+
@echo "Build finished."
96+
@echo "To view the help file:"
97+
@echo "# mkdir -p $$HOME/.local/share/devhelp/cycler"
98+
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/cycler"
99+
@echo "# devhelp"
100+
101+
epub:
102+
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
103+
@echo
104+
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
105+
106+
latex:
107+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
108+
@echo
109+
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
110+
@echo "Run \`make' in that directory to run these through (pdf)latex" \
111+
"(use \`make latexpdf' here to do that automatically)."
112+
113+
latexpdf:
114+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
115+
@echo "Running LaTeX files through pdflatex..."
116+
$(MAKE) -C $(BUILDDIR)/latex all-pdf
117+
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
118+
119+
latexpdfja:
120+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
121+
@echo "Running LaTeX files through platex and dvipdfmx..."
122+
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
123+
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
124+
125+
text:
126+
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
127+
@echo
128+
@echo "Build finished. The text files are in $(BUILDDIR)/text."
129+
130+
man:
131+
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
132+
@echo
133+
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
134+
135+
texinfo:
136+
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
137+
@echo
138+
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
139+
@echo "Run \`make' in that directory to run these through makeinfo" \
140+
"(use \`make info' here to do that automatically)."
141+
142+
info:
143+
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
144+
@echo "Running Texinfo files through makeinfo..."
145+
make -C $(BUILDDIR)/texinfo info
146+
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
147+
148+
gettext:
149+
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
150+
@echo
151+
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
152+
153+
changes:
154+
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
155+
@echo
156+
@echo "The overview file is in $(BUILDDIR)/changes."
157+
158+
linkcheck:
159+
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
160+
@echo
161+
@echo "Link check complete; look for any errors in the above output " \
162+
"or in $(BUILDDIR)/linkcheck/output.txt."
163+
164+
doctest:
165+
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
166+
@echo "Testing of doctests in the sources finished, look at the " \
167+
"results in $(BUILDDIR)/doctest/output.txt."
168+
169+
xml:
170+
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
171+
@echo
172+
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
173+
174+
pseudoxml:
175+
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
176+
@echo
177+
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

‎doc/_templates/autosummary/class.rst‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
{% extends "!autosummary/class.rst" %}
2+
3+
{% block methods %}
4+
{% if methods %}
5+
6+
.. HACK -- the point here is that we don't want this to appear in the output, but the autosummary should still generate the pages.
7+
.. autosummary::
8+
:toctree:
9+
{% for item in all_methods %}
10+
{%- if not item.startswith('_') or item in ['__call__'] %}
11+
{{ name }}.{{ item }}
12+
{%- endif -%}
13+
{%- endfor %}
14+
15+
{% endif %}
16+
{% endblock %}
17+
18+
{% block attributes %}
19+
{% if attributes %}
20+
21+
.. HACK -- the point here is that we don't want this to appear in the output, but the autosummary should still generate the pages.
22+
.. autosummary::
23+
:toctree:
24+
{% for item in all_attributes %}
25+
{%- if not item.startswith('_') %}
26+
{{ name }}.{{ item }}
27+
{%- endif -%}
28+
{%- endfor %}
29+
30+
{% endif %}
31+
{% endblock %}

‎doc/conf.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@
110110
# The name of the Pygments (syntax highlighting) style to use.
111111
pygments_style = 'sphinx'
112112

113-
default_role = 'obj'
113+
default_role = 'any'
114114

115115
# Plot directive configuration
116116
# ----------------------------

0 commit comments

Comments
 (0)