1
- # Makefile for Sphinx documentation
1
+ # Minimal makefile for Sphinx documentation
2
2
#
3
3
4
- # You can set these variables from the command line.
5
- SPHINXOPTS =
6
- SPHINXBUILD = 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 ?= sphinx-build
8
+ SOURCEDIR = .
8
9
BUILDDIR = _build
9
10
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 ) .
11
+ # Put it first so that "make" without argument is like "make help".
12
+ help :
13
+ @$(SPHINXBUILD ) -M help " $( SOURCEDIR) " " $( BUILDDIR) " $(SPHINXOPTS ) $(O )
14
+
15
+ .PHONY : help Makefile
16
+
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 )
21
+
14
22
15
23
REGENDOC_ARGS := \
16
24
--normalize "/[ \t]+\n/\n/" \
@@ -25,130 +33,8 @@ REGENDOC_ARGS := \
25
33
--normalize "@hypothesis-(\d+)\\.[.\d,]+@hypothesis-\1.x.y@" \
26
34
--normalize "@Python (\d+)\\.[^ ,]+@Python \1.x.y@"
27
35
28
- .PHONY : help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
29
-
30
-
31
- help :
32
- @echo " Please use \` make <target>' where <target> is one of"
33
- @echo " html to make standalone HTML files"
34
- @echo " latexpdf to make LaTeX files and run them through pdflatex"
35
- @echo " showtarget to show the pytest.org target directory"
36
- @echo " install to install docs to pytest.org/SITETARGET"
37
- @echo " install-ldf to install the doc pdf to pytest.org/SITETARGET"
38
- @echo " regen to regenerate pytest examples using the installed pytest"
39
- @echo " linkcheck to check all external links for integrity"
40
-
41
- clean :
42
- -rm -rf $(BUILDDIR ) /*
43
-
44
36
regen : REGENDOC_FILES:=* .rst * /* .rst
45
37
regen :
46
38
PYTHONDONTWRITEBYTECODE=1 PYTEST_ADDOPTS=" -pno:hypothesis -Wignore::pytest.PytestUnknownMarkWarning" COLUMNS=76 regendoc --update ${REGENDOC_FILES} ${REGENDOC_ARGS}
47
39
48
- html :
49
- $(SPHINXBUILD ) -b html $(ALLSPHINXOPTS ) $(BUILDDIR ) /html
50
- @echo
51
- @echo " Build finished. The HTML pages are in $( BUILDDIR) /html."
52
-
53
- dirhtml :
54
- $(SPHINXBUILD ) -b dirhtml $(ALLSPHINXOPTS ) $(BUILDDIR ) /dirhtml
55
- @echo
56
- @echo " Build finished. The HTML pages are in $( BUILDDIR) /dirhtml."
57
-
58
- singlehtml :
59
- $(SPHINXBUILD ) -b singlehtml $(ALLSPHINXOPTS ) $(BUILDDIR ) /singlehtml
60
- @echo
61
- @echo " Build finished. The HTML page is in $( BUILDDIR) /singlehtml."
62
-
63
- pickle :
64
- $(SPHINXBUILD ) -b pickle $(ALLSPHINXOPTS ) $(BUILDDIR ) /pickle
65
- @echo
66
- @echo " Build finished; now you can process the pickle files."
67
-
68
- json :
69
- $(SPHINXBUILD ) -b json $(ALLSPHINXOPTS ) $(BUILDDIR ) /json
70
- @echo
71
- @echo " Build finished; now you can process the JSON files."
72
-
73
- htmlhelp :
74
- $(SPHINXBUILD ) -b htmlhelp $(ALLSPHINXOPTS ) $(BUILDDIR ) /htmlhelp
75
- @echo
76
- @echo " Build finished; now you can run HTML Help Workshop with the" \
77
- " .hhp project file in $( BUILDDIR) /htmlhelp."
78
-
79
- qthelp :
80
- $(SPHINXBUILD ) -b qthelp $(ALLSPHINXOPTS ) $(BUILDDIR ) /qthelp
81
- @echo
82
- @echo " Build finished; now you can run " qcollectiongenerator" with the" \
83
- " .qhcp project file in $( BUILDDIR) /qthelp, like this:"
84
- @echo " # qcollectiongenerator $( BUILDDIR) /qthelp/pytest.qhcp"
85
- @echo " To view the help file:"
86
- @echo " # assistant -collectionFile $( BUILDDIR) /qthelp/pytest.qhc"
87
-
88
- devhelp :
89
- $(SPHINXBUILD ) -b devhelp $(ALLSPHINXOPTS ) $(BUILDDIR ) /devhelp
90
- @echo
91
- @echo " Build finished."
92
- @echo " To view the help file:"
93
- @echo " # mkdir -p $$ HOME/.local/share/devhelp/pytest"
94
- @echo " # ln -s $( BUILDDIR) /devhelp $$ HOME/.local/share/devhelp/pytest"
95
- @echo " # devhelp"
96
-
97
- epub :
98
- $(SPHINXBUILD ) -b epub $(ALLSPHINXOPTS ) $(BUILDDIR ) /epub
99
- @echo
100
- @echo " Build finished. The epub file is in $( BUILDDIR) /epub."
101
-
102
- latex :
103
- $(SPHINXBUILD ) -b latex $(ALLSPHINXOPTS ) $(BUILDDIR ) /latex
104
- @echo
105
- @echo " Build finished; the LaTeX files are in $( BUILDDIR) /latex."
106
- @echo " Run \` make' in that directory to run these through (pdf)latex" \
107
- " (use \` make latexpdf' here to do that automatically)."
108
-
109
- latexpdf :
110
- $(SPHINXBUILD ) -b latex $(ALLSPHINXOPTS ) $(BUILDDIR ) /latex
111
- @echo " Running LaTeX files through pdflatex..."
112
- make -C $(BUILDDIR ) /latex all-pdf
113
- @echo " pdflatex finished; the PDF files are in $( BUILDDIR) /latex."
114
-
115
- text :
116
- $(SPHINXBUILD ) -b text $(ALLSPHINXOPTS ) $(BUILDDIR ) /text
117
- @echo
118
- @echo " Build finished. The text files are in $( BUILDDIR) /text."
119
-
120
- man :
121
- $(SPHINXBUILD ) -b man $(ALLSPHINXOPTS ) $(BUILDDIR ) /man
122
- @echo
123
- @echo " Build finished. The manual pages are in $( BUILDDIR) /man."
124
-
125
- changes :
126
- $(SPHINXBUILD ) -b changes $(ALLSPHINXOPTS ) $(BUILDDIR ) /changes
127
- @echo
128
- @echo " The overview file is in $( BUILDDIR) /changes."
129
-
130
- linkcheck :
131
- $(SPHINXBUILD ) -b linkcheck $(ALLSPHINXOPTS ) $(BUILDDIR ) /linkcheck
132
- @echo
133
- @echo " Link check complete; look for any errors in the above output " \
134
- " or in $( BUILDDIR) /linkcheck/output.txt."
135
-
136
- doctest :
137
- $(SPHINXBUILD ) -b doctest $(ALLSPHINXOPTS ) $(BUILDDIR ) /doctest
138
- @echo " Testing of doctests in the sources finished, look at the " \
139
- " results in $( BUILDDIR) /doctest/output.txt."
140
-
141
- texinfo :
142
- mkdir -p $(BUILDDIR ) /texinfo
143
- $(SPHINXBUILD ) -b texinfo $(ALLSPHINXOPTS ) $(BUILDDIR ) /texinfo
144
- @echo
145
- @echo " Build finished. The Texinfo files are in $( BUILDDIR) /texinfo."
146
- @echo " Run \` make' in that directory to run these through makeinfo" \
147
- " (use \` make info' here to do that automatically)."
148
-
149
- info :
150
- mkdir -p $(BUILDDIR ) /texinfo
151
- $(SPHINXBUILD ) -b texinfo $(ALLSPHINXOPTS ) $(BUILDDIR ) /texinfo
152
- @echo " Running Texinfo files through makeinfo..."
153
- make -C $(BUILDDIR ) /texinfo info
154
- @echo " makeinfo finished; the Info files are in $( BUILDDIR) /texinfo."
40
+ .PHONY : regen
0 commit comments