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