2
2
3
3
# You can set these variables from the command line.
4
4
SPHINXOPTS =
5
- SPHINXBUILD = sphinx-build
5
+ SPHINXBUILD = pipenv run sphinx-build
6
6
PAPER =
7
7
BUILDDIR = _build
8
8
9
- # User-friendly check for sphinx-build
10
- ifeq ($(shell which $(SPHINXBUILD ) >/dev/null 2>&1; echo $$? ) , 1)
11
- $(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/)
12
- endif
13
-
14
9
# Internal variables.
15
10
PAPEROPT_a4 = -D latex_paper_size=a4
16
11
PAPEROPT_letter = -D latex_paper_size=letter
@@ -52,38 +47,38 @@ clean:
52
47
rm -rf $(BUILDDIR ) /*
53
48
54
49
html :
55
- pipenv run $(SPHINXBUILD ) -b html $(ALLSPHINXOPTS ) $(BUILDDIR ) /html
50
+ $(SPHINXBUILD ) -b html $(ALLSPHINXOPTS ) $(BUILDDIR ) /html
56
51
@echo
57
52
@echo " Build finished. The HTML pages are in $( BUILDDIR) /html."
58
53
59
54
dirhtml :
60
- pipenv run $(SPHINXBUILD ) -b dirhtml $(ALLSPHINXOPTS ) $(BUILDDIR ) /dirhtml
55
+ $(SPHINXBUILD ) -b dirhtml $(ALLSPHINXOPTS ) $(BUILDDIR ) /dirhtml
61
56
@echo
62
57
@echo " Build finished. The HTML pages are in $( BUILDDIR) /dirhtml."
63
58
64
59
singlehtml :
65
- pipenv run $(SPHINXBUILD ) -b singlehtml $(ALLSPHINXOPTS ) $(BUILDDIR ) /singlehtml
60
+ $(SPHINXBUILD ) -b singlehtml $(ALLSPHINXOPTS ) $(BUILDDIR ) /singlehtml
66
61
@echo
67
62
@echo " Build finished. The HTML page is in $( BUILDDIR) /singlehtml."
68
63
69
64
pickle :
70
- pipenv run $(SPHINXBUILD ) -b pickle $(ALLSPHINXOPTS ) $(BUILDDIR ) /pickle
65
+ $(SPHINXBUILD ) -b pickle $(ALLSPHINXOPTS ) $(BUILDDIR ) /pickle
71
66
@echo
72
67
@echo " Build finished; now you can process the pickle files."
73
68
74
69
json :
75
- pipenv run $(SPHINXBUILD ) -b json $(ALLSPHINXOPTS ) $(BUILDDIR ) /json
70
+ $(SPHINXBUILD ) -b json $(ALLSPHINXOPTS ) $(BUILDDIR ) /json
76
71
@echo
77
72
@echo " Build finished; now you can process the JSON files."
78
73
79
74
htmlhelp :
80
- pipenv run $(SPHINXBUILD ) -b htmlhelp $(ALLSPHINXOPTS ) $(BUILDDIR ) /htmlhelp
75
+ $(SPHINXBUILD ) -b htmlhelp $(ALLSPHINXOPTS ) $(BUILDDIR ) /htmlhelp
81
76
@echo
82
77
@echo " Build finished; now you can run HTML Help Workshop with the" \
83
78
" .hhp project file in $( BUILDDIR) /htmlhelp."
84
79
85
80
qthelp :
86
- pipenv run $(SPHINXBUILD ) -b qthelp $(ALLSPHINXOPTS ) $(BUILDDIR ) /qthelp
81
+ $(SPHINXBUILD ) -b qthelp $(ALLSPHINXOPTS ) $(BUILDDIR ) /qthelp
87
82
@echo
88
83
@echo " Build finished; now you can run " qcollectiongenerator" with the" \
89
84
" .qhcp project file in $( BUILDDIR) /qthelp, like this:"
@@ -92,15 +87,15 @@ qthelp:
92
87
@echo " # assistant -collectionFile $( BUILDDIR) /qthelp/PHP-HTTP.qhc"
93
88
94
89
applehelp :
95
- pipenv run $(SPHINXBUILD ) -b applehelp $(ALLSPHINXOPTS ) $(BUILDDIR ) /applehelp
90
+ $(SPHINXBUILD ) -b applehelp $(ALLSPHINXOPTS ) $(BUILDDIR ) /applehelp
96
91
@echo
97
92
@echo " Build finished. The help book is in $( BUILDDIR) /applehelp."
98
93
@echo " N.B. You won't be able to view it unless you put it in" \
99
94
" ~/Library/Documentation/Help or install it in your application" \
100
95
" bundle."
101
96
102
97
devhelp :
103
- pipenv run $(SPHINXBUILD ) -b devhelp $(ALLSPHINXOPTS ) $(BUILDDIR ) /devhelp
98
+ $(SPHINXBUILD ) -b devhelp $(ALLSPHINXOPTS ) $(BUILDDIR ) /devhelp
104
99
@echo
105
100
@echo " Build finished."
106
101
@echo " To view the help file:"
@@ -109,88 +104,88 @@ devhelp:
109
104
@echo " # devhelp"
110
105
111
106
epub :
112
- pipenv run $(SPHINXBUILD ) -b epub $(ALLSPHINXOPTS ) $(BUILDDIR ) /epub
107
+ $(SPHINXBUILD ) -b epub $(ALLSPHINXOPTS ) $(BUILDDIR ) /epub
113
108
@echo
114
109
@echo " Build finished. The epub file is in $( BUILDDIR) /epub."
115
110
116
111
latex :
117
- pipenv run $(SPHINXBUILD ) -b latex $(ALLSPHINXOPTS ) $(BUILDDIR ) /latex
112
+ $(SPHINXBUILD ) -b latex $(ALLSPHINXOPTS ) $(BUILDDIR ) /latex
118
113
@echo
119
114
@echo " Build finished; the LaTeX files are in $( BUILDDIR) /latex."
120
115
@echo " Run \` make' in that directory to run these through (pdf)latex" \
121
116
" (use \` make latexpdf' here to do that automatically)."
122
117
123
118
latexpdf :
124
- pipenv run $(SPHINXBUILD ) -b latex $(ALLSPHINXOPTS ) $(BUILDDIR ) /latex
119
+ $(SPHINXBUILD ) -b latex $(ALLSPHINXOPTS ) $(BUILDDIR ) /latex
125
120
@echo " Running LaTeX files through pdflatex..."
126
121
$(MAKE ) -C $(BUILDDIR ) /latex all-pdf
127
122
@echo " pdflatex finished; the PDF files are in $( BUILDDIR) /latex."
128
123
129
124
latexpdfja :
130
- pipenv run $(SPHINXBUILD ) -b latex $(ALLSPHINXOPTS ) $(BUILDDIR ) /latex
125
+ $(SPHINXBUILD ) -b latex $(ALLSPHINXOPTS ) $(BUILDDIR ) /latex
131
126
@echo " Running LaTeX files through platex and dvipdfmx..."
132
127
$(MAKE ) -C $(BUILDDIR ) /latex all-pdf-ja
133
128
@echo " pdflatex finished; the PDF files are in $( BUILDDIR) /latex."
134
129
135
130
text :
136
- pipenv run $(SPHINXBUILD ) -b text $(ALLSPHINXOPTS ) $(BUILDDIR ) /text
131
+ $(SPHINXBUILD ) -b text $(ALLSPHINXOPTS ) $(BUILDDIR ) /text
137
132
@echo
138
133
@echo " Build finished. The text files are in $( BUILDDIR) /text."
139
134
140
135
man :
141
- pipenv run $(SPHINXBUILD ) -b man $(ALLSPHINXOPTS ) $(BUILDDIR ) /man
136
+ $(SPHINXBUILD ) -b man $(ALLSPHINXOPTS ) $(BUILDDIR ) /man
142
137
@echo
143
138
@echo " Build finished. The manual pages are in $( BUILDDIR) /man."
144
139
145
140
texinfo :
146
- pipenv run $(SPHINXBUILD ) -b texinfo $(ALLSPHINXOPTS ) $(BUILDDIR ) /texinfo
141
+ $(SPHINXBUILD ) -b texinfo $(ALLSPHINXOPTS ) $(BUILDDIR ) /texinfo
147
142
@echo
148
143
@echo " Build finished. The Texinfo files are in $( BUILDDIR) /texinfo."
149
144
@echo " Run \` make' in that directory to run these through makeinfo" \
150
145
" (use \` make info' here to do that automatically)."
151
146
152
147
info :
153
- pipenv run $(SPHINXBUILD ) -b texinfo $(ALLSPHINXOPTS ) $(BUILDDIR ) /texinfo
148
+ $(SPHINXBUILD ) -b texinfo $(ALLSPHINXOPTS ) $(BUILDDIR ) /texinfo
154
149
@echo " Running Texinfo files through makeinfo..."
155
150
make -C $(BUILDDIR ) /texinfo info
156
151
@echo " makeinfo finished; the Info files are in $( BUILDDIR) /texinfo."
157
152
158
153
gettext :
159
- pipenv run $(SPHINXBUILD ) -b gettext $(I18NSPHINXOPTS ) $(BUILDDIR ) /locale
154
+ $(SPHINXBUILD ) -b gettext $(I18NSPHINXOPTS ) $(BUILDDIR ) /locale
160
155
@echo
161
156
@echo " Build finished. The message catalogs are in $( BUILDDIR) /locale."
162
157
163
158
changes :
164
- pipenv run $(SPHINXBUILD ) -b changes $(ALLSPHINXOPTS ) $(BUILDDIR ) /changes
159
+ $(SPHINXBUILD ) -b changes $(ALLSPHINXOPTS ) $(BUILDDIR ) /changes
165
160
@echo
166
161
@echo " The overview file is in $( BUILDDIR) /changes."
167
162
168
163
linkcheck :
169
- pipenv run $(SPHINXBUILD ) -b linkcheck $(ALLSPHINXOPTS ) $(BUILDDIR ) /linkcheck
164
+ $(SPHINXBUILD ) -b linkcheck $(ALLSPHINXOPTS ) $(BUILDDIR ) /linkcheck
170
165
@echo
171
166
@echo " Link check complete; look for any errors in the above output " \
172
167
" or in $( BUILDDIR) /linkcheck/output.txt."
173
168
174
169
doctest :
175
- pipenv run $(SPHINXBUILD ) -b doctest $(ALLSPHINXOPTS ) $(BUILDDIR ) /doctest
170
+ $(SPHINXBUILD ) -b doctest $(ALLSPHINXOPTS ) $(BUILDDIR ) /doctest
176
171
@echo " Testing of doctests in the sources finished, look at the " \
177
172
" results in $( BUILDDIR) /doctest/output.txt."
178
173
179
174
coverage :
180
- pipenv run $(SPHINXBUILD ) -b coverage $(ALLSPHINXOPTS ) $(BUILDDIR ) /coverage
175
+ $(SPHINXBUILD ) -b coverage $(ALLSPHINXOPTS ) $(BUILDDIR ) /coverage
181
176
@echo " Testing of coverage in the sources finished, look at the " \
182
177
" results in $( BUILDDIR) /coverage/python.txt."
183
178
184
179
xml :
185
- pipenv run $(SPHINXBUILD ) -b xml $(ALLSPHINXOPTS ) $(BUILDDIR ) /xml
180
+ $(SPHINXBUILD ) -b xml $(ALLSPHINXOPTS ) $(BUILDDIR ) /xml
186
181
@echo
187
182
@echo " Build finished. The XML files are in $( BUILDDIR) /xml."
188
183
189
184
pseudoxml :
190
- pipenv run $(SPHINXBUILD ) -b pseudoxml $(ALLSPHINXOPTS ) $(BUILDDIR ) /pseudoxml
185
+ $(SPHINXBUILD ) -b pseudoxml $(ALLSPHINXOPTS ) $(BUILDDIR ) /pseudoxml
191
186
@echo
192
187
@echo " Build finished. The pseudo-XML files are in $( BUILDDIR) /pseudoxml."
193
188
194
189
spelling :
195
- pipenv run $(SPHINXBUILD ) -b spelling $(ALLSPHINXOPTS ) $(BUILDDIR ) /spelling
190
+ $(SPHINXBUILD ) -b spelling $(ALLSPHINXOPTS ) $(BUILDDIR ) /spelling
196
191
@echo " Spelling report generated in $( BUILDDIR) /spelling/output.txt"
0 commit comments