@@ -35,160 +35,166 @@ distclean: clean ## Clean docs build directory, Python virtual environment, and
35
35
rm docs/plone.api
36
36
rm docs/plone.restapi
37
37
rm docs/volto
38
- @echo
39
38
@echo " Cleaned docs build directory, Python virtual environment, and symlinks."
39
+ @echo
40
40
41
41
venv/bin/python : # # Setup up Python virtual environment and install requirements
42
42
python3 -m venv venv
43
43
venv/bin/pip install -r requirements-initial.txt
44
44
venv/bin/pip install -r requirements.txt
45
- @echo
46
45
@echo " Installation of requirements completed."
46
+ @echo
47
47
48
48
docs/plone.api : # # Setup plone.api docs
49
49
git submodule init
50
50
git submodule update
51
51
ln -s ../submodules/plone.api/docs ./docs/plone.api
52
- @echo
53
52
@echo " Documentation of plone.api initialized."
53
+ @echo
54
54
55
- .PHONY : install- api
56
- install-api : docs /plone.api
55
+ venv/plone.api-install : docs/plone. api
56
+ touch venv /plone.api-install
57
57
venv/bin/pip install plone.api -c submodules/plone.api/constraints.txt
58
58
venv/bin/pip install --no-deps -e submodules/plone.api/" [test]"
59
+ @echo " plone.api installed."
60
+ @echo
59
61
60
62
docs/plone.restapi : # # Setup plone.restapi docs
61
63
git submodule init
62
64
git submodule update
63
65
ln -s ../submodules/plone.restapi ./docs/plone.restapi
64
- @echo
65
66
@echo " Documentation of plone.restapi initialized."
67
+ @echo
66
68
67
69
docs/volto : # # Setup Volto docs
68
70
git submodule init
69
71
git submodule update
70
72
ln -s ../submodules/volto/docs/source ./docs/volto
71
- @echo
72
73
@echo " Documentation of volto initialized."
74
+ @echo
73
75
74
76
.PHONY : deps
75
- deps : venv/bin/python docs/volto docs/plone.restapi install- api # # Create Python virtual environment, install requirements, initialize or update the volto, plone.restapi, and plone.api submodules, and finally create symlinks to the source files.
77
+ deps : venv/bin/python docs/volto docs/plone.restapi venv/plone. api-install # # Create Python virtual environment, install requirements, initialize or update the volto, plone.restapi, and plone.api submodules, create symlinks to the source files, and finally install plone.api .
76
78
77
79
.PHONY : html
78
80
html : deps # # Build html
79
81
cd $(DOCS_DIR ) && $(SPHINXBUILD ) -b html $(ALLSPHINXOPTS ) $(BUILDDIR ) /html
80
- @echo
81
82
@echo " Build finished. The HTML pages are in $( BUILDDIR) /html."
83
+ @echo
82
84
83
85
.PHONY : manual
84
86
manual : deps
85
87
cd $(DOCS_DIR ) && $(SPHINXBUILD ) -b html -t manual . $(BUILDDIR ) /manual
88
+ @echo " Build finished. The manual pages are in $( BUILDDIR) /manual."
89
+ @echo
86
90
87
91
.PHONY : dirhtml
88
92
dirhtml : deps
89
93
cd $(DOCS_DIR ) && $(SPHINXBUILD ) -b dirhtml $(ALLSPHINXOPTS ) $(BUILDDIR ) /dirhtml
90
- @echo
91
94
@echo " Build finished. The HTML pages are in $( BUILDDIR) /dirhtml."
95
+ @echo
92
96
93
97
.PHONY : singlehtml
94
98
singlehtml : deps
95
99
cd $(DOCS_DIR ) && $(SPHINXBUILD ) -b singlehtml $(ALLSPHINXOPTS ) $(BUILDDIR ) /singlehtml
96
- @echo
97
100
@echo " Build finished. The HTML page is in $( BUILDDIR) /singlehtml."
101
+ @echo
98
102
99
103
.PHONY : pickle
100
104
pickle : deps
101
105
cd $(DOCS_DIR ) && $(SPHINXBUILD ) -b pickle $(ALLSPHINXOPTS ) $(BUILDDIR ) /pickle
102
- @echo
103
106
@echo " Build finished; now you can process the pickle files."
107
+ @echo
104
108
105
109
.PHONY : json
106
110
json : deps
107
111
cd $(DOCS_DIR ) && $(SPHINXBUILD ) -b json $(ALLSPHINXOPTS ) $(BUILDDIR ) /json
108
- @echo
109
112
@echo " Build finished; now you can process the JSON files."
113
+ @echo
110
114
111
115
.PHONY : htmlhelp
112
116
htmlhelp : deps
113
117
cd $(DOCS_DIR ) && $(SPHINXBUILD ) -b htmlhelp $(ALLSPHINXOPTS ) $(BUILDDIR ) /htmlhelp
114
- @echo
115
118
@echo " Build finished; now you can run HTML Help Workshop with the" \
116
119
" .hhp project file in $( BUILDDIR) /htmlhelp."
120
+ @echo
117
121
118
122
.PHONY : epub
119
123
epub : deps
120
124
cd $(DOCS_DIR ) && $(SPHINXBUILD ) -b epub $(ALLSPHINXOPTS ) $(BUILDDIR ) /epub
121
- @echo
122
125
@echo " Build finished. The epub file is in $( BUILDDIR) /epub."
126
+ @echo
123
127
124
128
.PHONY : latex
125
129
latex : deps
126
130
cd $(DOCS_DIR ) && $(SPHINXBUILD ) -b latex $(ALLSPHINXOPTS ) $(BUILDDIR ) /latex
127
- @echo
128
131
@echo " Build finished; the LaTeX files are in $( BUILDDIR) /latex."
129
132
@echo " Run \` make' in that directory to run these through (pdf)latex" \
130
133
" (use \` make latexpdf' here to do that automatically)."
134
+ @echo
131
135
132
136
.PHONY : latexpdf
133
137
latexpdf : deps
134
138
cd $(DOCS_DIR ) && $(SPHINXBUILD ) -b latex $(ALLSPHINXOPTS ) $(BUILDDIR ) /latex
135
139
@echo " Running LaTeX files through pdflatex..."
136
140
$(MAKE ) -C $(BUILDDIR ) /latex all-pdf
137
141
@echo " pdflatex finished; the PDF files are in $( BUILDDIR) /latex."
142
+ @echo
138
143
139
144
.PHONY : text
140
145
text : deps
141
146
cd $(DOCS_DIR ) && $(SPHINXBUILD ) -b text $(ALLSPHINXOPTS ) $(BUILDDIR ) /text
142
- @echo
143
147
@echo " Build finished. The text files are in $( BUILDDIR) /text."
148
+ @echo
144
149
145
150
.PHONY : man
146
151
man : deps
147
152
cd $(DOCS_DIR ) && $(SPHINXBUILD ) -b man $(ALLSPHINXOPTS ) $(BUILDDIR ) /man
148
- @echo
149
153
@echo " Build finished. The manual pages are in $( BUILDDIR) /man."
154
+ @echo
150
155
151
156
.PHONY : texinfo
152
157
texinfo : deps
153
158
cd $(DOCS_DIR ) && $(SPHINXBUILD ) -b texinfo $(ALLSPHINXOPTS ) $(BUILDDIR ) /texinfo
154
- @echo
155
159
@echo " Build finished. The Texinfo files are in $( BUILDDIR) /texinfo."
156
160
@echo " Run \` make' in that directory to run these through makeinfo" \
157
161
" (use \` make info' here to do that automatically)."
162
+ @echo
158
163
159
164
.PHONY : info
160
165
info : deps
161
166
cd $(DOCS_DIR ) && $(SPHINXBUILD ) -b texinfo $(ALLSPHINXOPTS ) $(BUILDDIR ) /texinfo
162
167
@echo " Running Texinfo files through makeinfo..."
163
168
make -C $(BUILDDIR ) /texinfo info
164
169
@echo " makeinfo finished; the Info files are in $( BUILDDIR) /texinfo."
170
+ @echo
165
171
166
172
.PHONY : changes
167
173
changes : deps
168
174
cd $(DOCS_DIR ) && $(SPHINXBUILD ) -b changes $(ALLSPHINXOPTS ) $(BUILDDIR ) /changes
169
- @echo
170
175
@echo " The overview file is in $( BUILDDIR) /changes."
176
+ @echo
171
177
172
178
.PHONY : linkcheck
173
179
linkcheck : deps # # Run linkcheck
174
180
cd $(DOCS_DIR ) && $(SPHINXBUILD ) -b linkcheck $(ALLSPHINXOPTS ) $(BUILDDIR ) /linkcheck
175
- @echo
176
181
@echo " Link check complete; look for any errors in the above output " \
177
182
" or in $( BUILDDIR) /linkcheck/ ."
183
+ @echo
178
184
179
185
.PHONY : linkcheckbroken
180
186
linkcheckbroken : deps # # Run linkcheck and show only broken links
181
187
cd $(DOCS_DIR ) && $(SPHINXBUILD ) -b linkcheck $(ALLSPHINXOPTS ) $(BUILDDIR ) /linkcheck | GREP_COLORS=' 0;31' grep -wi " broken\|redirect" --color=always | GREP_COLORS=' 0;31' grep -vi " https://github.com/plone/volto/issues/" --color=always && if test $$ ? = 0; then exit 1; fi || test $$? = 1
182
- @echo
183
188
@echo " Link check complete; look for any errors in the above output " \
184
189
" or in $( BUILDDIR) /linkcheck/ ."
190
+ @echo
185
191
186
192
.PHONY : vale
187
193
vale : deps # # Run Vale style, grammar, and spell checks
188
194
venv/bin/vale sync
189
195
venv/bin/vale --no-wrap $(VALEOPTS ) $(VALEFILES )
190
- @echo
191
196
@echo " Vale is finished; look for any errors in the above output."
197
+ @echo
192
198
193
199
.PHONY : html_meta
194
200
html_meta : deps # # Add meta data headers to all Markdown pages
@@ -199,6 +205,7 @@ doctest: deps
199
205
cd $(DOCS_DIR ) && $(SPHINXBUILD ) -b doctest $(ALLSPHINXOPTS ) $(BUILDDIR ) /doctest
200
206
@echo " Testing of doctests in the sources finished, look at the " \
201
207
" results in $( BUILDDIR) /doctest/output.txt."
208
+ @echo
202
209
203
210
.PHONY : test
204
211
test : clean linkcheckbroken # # Clean docs build, then run linkcheckbroken
0 commit comments