Skip to content

Commit 8090d4b

Browse files
alexfiklalexfikl
committed
docs: add arraycontext
1 parent 8f8304e commit 8090d4b

File tree

6 files changed

+20
-135
lines changed

6 files changed

+20
-135
lines changed

‎.pylintrc-local.yml‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,2 @@
11
- arg: extension-pkg-whitelist
22
val: pyfmmlib
3-
4-
# Needed for boxtree.tools
5-
- arg: init-hook
6-
val: import sys; sys.setrecursionlimit(2000)

‎boxtree/__init__.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -111,15 +111,15 @@
111111
two arrays, one whose name ends in ``_starts``, and another whose
112112
name ends in ``_lists``. For example,
113113
suppose we would like to find the colleagues of box #17 using
114-
:attr:`boxtree.traversal.FMMTraversalInfo.colleagues_starts`
114+
:attr:`boxtree.traversal.FMMTraversalInfo.same_level_non_well_sep_boxes_starts`
115115
and
116-
:attr:`boxtree.traversal.FMMTraversalInfo.colleagues_lists`.
116+
:attr:`boxtree.traversal.FMMTraversalInfo.same_level_non_well_sep_boxes_lists`.
117117
118118
The following snippet of code achieves this::
119119
120120
ibox = 17
121-
start, end = colleagues_starts[ibox:ibox+2]
122-
ibox_colleagues = colleagues_lists[start:end]
121+
start, end = same_level_non_well_sep_boxes_starts[ibox:ibox+2]
122+
ibox_colleagues = same_level_non_well_sep_boxes_lists[start:end]
123123
124124
This indexing scheme has the following properties:
125125

‎boxtree/tree.py‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52,10 +52,6 @@
5252
^^^^^
5353
5454
.. autoclass:: ParticleListFilter
55-
56-
.. autofunction:: filter_target_lists_in_user_order
57-
58-
.. autofunction:: filter_target_lists_in_tree_order
5955
"""
6056

6157
__copyright__ = "Copyright (C) 2013 Andreas Kloeckner"

‎doc/Makefile‎

Lines changed: 13 additions & 123 deletions
Original file line numberDiff line numberDiff line change
@@ -1,130 +1,20 @@
1-
# Makefile for Sphinx documentation
1+
# Minimal makefile for Sphinx documentation
22
#
33

4-
# You can set these variables from the command line.
5-
SPHINXOPTS =
6-
SPHINXBUILD = python $(shell which sphinx-build)
7-
PAPER =
4+
# You can set these variables from the command line, and also
5+
# from the environment for the first two.
6+
SPHINXOPTS ?=
7+
SPHINXBUILD ?= python $(shell which sphinx-build)
8+
SOURCEDIR = .
89
BUILDDIR = _build
910

10-
# Internal variables.
11-
PAPEROPT_a4 = -D latex_paper_size=a4
12-
PAPEROPT_letter = -D latex_paper_size=letter
13-
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
14-
15-
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
16-
11+
# Put it first so that "make" without argument is like "make help".
1712
help:
18-
@echo "Please use \`make <target>' where <target> is one of"
19-
@echo " html to make standalone HTML files"
20-
@echo " dirhtml to make HTML files named index.html in directories"
21-
@echo " singlehtml to make a single large HTML file"
22-
@echo " pickle to make pickle files"
23-
@echo " json to make JSON files"
24-
@echo " htmlhelp to make HTML files and a HTML help project"
25-
@echo " qthelp to make HTML files and a qthelp project"
26-
@echo " devhelp to make HTML files and a Devhelp project"
27-
@echo " epub to make an epub"
28-
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
29-
@echo " latexpdf to make LaTeX files and run them through pdflatex"
30-
@echo " text to make text files"
31-
@echo " man to make manual pages"
32-
@echo " changes to make an overview of all changed/added/deprecated items"
33-
@echo " linkcheck to check all external links for integrity"
34-
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
35-
36-
clean:
37-
-rm -rf $(BUILDDIR)/*
38-
39-
html:
40-
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
41-
@echo
42-
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
43-
44-
dirhtml:
45-
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
46-
@echo
47-
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
48-
49-
singlehtml:
50-
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
51-
@echo
52-
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
53-
54-
pickle:
55-
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
56-
@echo
57-
@echo "Build finished; now you can process the pickle files."
58-
59-
json:
60-
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
61-
@echo
62-
@echo "Build finished; now you can process the JSON files."
63-
64-
htmlhelp:
65-
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
66-
@echo
67-
@echo "Build finished; now you can run HTML Help Workshop with the" \
68-
".hhp project file in $(BUILDDIR)/htmlhelp."
69-
70-
qthelp:
71-
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
72-
@echo
73-
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
74-
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
75-
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/boxtree.qhcp"
76-
@echo "To view the help file:"
77-
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/boxtree.qhc"
78-
79-
devhelp:
80-
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
81-
@echo
82-
@echo "Build finished."
83-
@echo "To view the help file:"
84-
@echo "# mkdir -p $$HOME/.local/share/devhelp/boxtree"
85-
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/boxtree"
86-
@echo "# devhelp"
87-
88-
epub:
89-
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
90-
@echo
91-
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
92-
93-
latex:
94-
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
95-
@echo
96-
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
97-
@echo "Run \`make' in that directory to run these through (pdf)latex" \
98-
"(use \`make latexpdf' here to do that automatically)."
99-
100-
latexpdf:
101-
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
102-
@echo "Running LaTeX files through pdflatex..."
103-
make -C $(BUILDDIR)/latex all-pdf
104-
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
105-
106-
text:
107-
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
108-
@echo
109-
@echo "Build finished. The text files are in $(BUILDDIR)/text."
110-
111-
man:
112-
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
113-
@echo
114-
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
115-
116-
changes:
117-
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
118-
@echo
119-
@echo "The overview file is in $(BUILDDIR)/changes."
13+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
12014

121-
linkcheck:
122-
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
123-
@echo
124-
@echo "Link check complete; look for any errors in the above output " \
125-
"or in $(BUILDDIR)/linkcheck/output.txt."
15+
.PHONY: help Makefile
12616

127-
doctest:
128-
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
129-
@echo "Testing of doctests in the sources finished, look at the " \
130-
"results in $(BUILDDIR)/doctest/output.txt."
17+
# Catch-all target: route all unknown targets to Sphinx using the new
18+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19+
%: Makefile
20+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

‎doc/conf.py‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,5 +18,6 @@
1818
"https://docs.python.org/3/": None,
1919
"https://numpy.org/doc/stable/": None,
2020
"https://documen.tician.de/pyopencl/": None,
21+
"https://documen.tician.de/arraycontext/": None,
2122
"https://documen.tician.de/pytential/": None,
2223
}

‎doc/tools.rst‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,5 @@ Utility Functionality
44
.. automodule:: boxtree.timing
55

66
.. automodule:: boxtree.constant_one
7+
8+
.. automodule:: boxtree.array_context

0 commit comments

Comments
 (0)