Skip to content

Commit e1c4197

Browse files
committed
Move blank @echos as the last command in each target to make it easier to see if it completed.
1 parent 7af39aa commit e1c4197

File tree

1 file changed

+25
-20
lines changed

1 file changed

+25
-20
lines changed

Makefile

Lines changed: 25 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -35,22 +35,22 @@ distclean: clean ## Clean docs build directory, Python virtual environment, and
3535
rm docs/plone.api
3636
rm docs/plone.restapi
3737
rm docs/volto
38-
@echo
3938
@echo "Cleaned docs build directory, Python virtual environment, and symlinks."
39+
@echo
4040

4141
venv/bin/python: ## Setup up Python virtual environment and install requirements
4242
python3 -m venv venv
4343
venv/bin/pip install -r requirements-initial.txt
4444
venv/bin/pip install -r requirements.txt
45-
@echo
4645
@echo "Installation of requirements completed."
46+
@echo
4747

4848
docs/plone.api: ## Setup plone.api docs
4949
git submodule init
5050
git submodule update
5151
ln -s ../submodules/plone.api/docs ./docs/plone.api
52-
@echo
5352
@echo "Documentation of plone.api initialized."
53+
@echo
5454

5555
plone.api-install: docs/plone.api
5656
touch plone.api-install
@@ -63,134 +63,138 @@ docs/plone.restapi: ## Setup plone.restapi docs
6363
git submodule init
6464
git submodule update
6565
ln -s ../submodules/plone.restapi ./docs/plone.restapi
66-
@echo
6766
@echo "Documentation of plone.restapi initialized."
67+
@echo
6868

6969
docs/volto: ## Setup Volto docs
7070
git submodule init
7171
git submodule update
7272
ln -s ../submodules/volto/docs/source ./docs/volto
73-
@echo
7473
@echo "Documentation of volto initialized."
74+
@echo
7575

7676
.PHONY: deps
7777
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.
7878

7979
.PHONY: html
8080
html: deps ## Build html
8181
cd $(DOCS_DIR) && $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
82-
@echo
8382
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
83+
@echo
8484

8585
.PHONY: manual
8686
manual: deps
8787
cd $(DOCS_DIR) && $(SPHINXBUILD) -b html -t manual . $(BUILDDIR)/manual
88+
@echo "Build finished. The manual pages are in $(BUILDDIR)/manual."
89+
@echo
8890

8991
.PHONY: dirhtml
9092
dirhtml: deps
9193
cd $(DOCS_DIR) && $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
92-
@echo
9394
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
95+
@echo
9496

9597
.PHONY: singlehtml
9698
singlehtml: deps
9799
cd $(DOCS_DIR) && $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
98-
@echo
99100
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
101+
@echo
100102

101103
.PHONY: pickle
102104
pickle: deps
103105
cd $(DOCS_DIR) && $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
104-
@echo
105106
@echo "Build finished; now you can process the pickle files."
107+
@echo
106108

107109
.PHONY: json
108110
json: deps
109111
cd $(DOCS_DIR) && $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
110-
@echo
111112
@echo "Build finished; now you can process the JSON files."
113+
@echo
112114

113115
.PHONY: htmlhelp
114116
htmlhelp: deps
115117
cd $(DOCS_DIR) && $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
116-
@echo
117118
@echo "Build finished; now you can run HTML Help Workshop with the" \
118119
".hhp project file in $(BUILDDIR)/htmlhelp."
120+
@echo
119121

120122
.PHONY: epub
121123
epub: deps
122124
cd $(DOCS_DIR) && $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
123-
@echo
124125
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
126+
@echo
125127

126128
.PHONY: latex
127129
latex: deps
128130
cd $(DOCS_DIR) && $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
129-
@echo
130131
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
131132
@echo "Run \`make' in that directory to run these through (pdf)latex" \
132133
"(use \`make latexpdf' here to do that automatically)."
134+
@echo
133135

134136
.PHONY: latexpdf
135137
latexpdf: deps
136138
cd $(DOCS_DIR) && $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
137139
@echo "Running LaTeX files through pdflatex..."
138140
$(MAKE) -C $(BUILDDIR)/latex all-pdf
139141
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
142+
@echo
140143

141144
.PHONY: text
142145
text: deps
143146
cd $(DOCS_DIR) && $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
144-
@echo
145147
@echo "Build finished. The text files are in $(BUILDDIR)/text."
148+
@echo
146149

147150
.PHONY: man
148151
man: deps
149152
cd $(DOCS_DIR) && $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
150-
@echo
151153
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
154+
@echo
152155

153156
.PHONY: texinfo
154157
texinfo: deps
155158
cd $(DOCS_DIR) && $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
156-
@echo
157159
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
158160
@echo "Run \`make' in that directory to run these through makeinfo" \
159161
"(use \`make info' here to do that automatically)."
162+
@echo
160163

161164
.PHONY: info
162165
info: deps
163166
cd $(DOCS_DIR) && $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
164167
@echo "Running Texinfo files through makeinfo..."
165168
make -C $(BUILDDIR)/texinfo info
166169
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
170+
@echo
167171

168172
.PHONY: changes
169173
changes: deps
170174
cd $(DOCS_DIR) && $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
171-
@echo
172175
@echo "The overview file is in $(BUILDDIR)/changes."
176+
@echo
173177

174178
.PHONY: linkcheck
175179
linkcheck: deps ## Run linkcheck
176180
cd $(DOCS_DIR) && $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
177-
@echo
178181
@echo "Link check complete; look for any errors in the above output " \
179182
"or in $(BUILDDIR)/linkcheck/ ."
183+
@echo
180184

181185
.PHONY: linkcheckbroken
182186
linkcheckbroken: deps ## Run linkcheck and show only broken links
183187
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
185188
@echo "Link check complete; look for any errors in the above output " \
186189
"or in $(BUILDDIR)/linkcheck/ ."
190+
@echo
187191

188192
.PHONY: vale
189193
vale: deps ## Run Vale style, grammar, and spell checks
190194
venv/bin/vale sync
191195
venv/bin/vale --no-wrap $(VALEOPTS) $(VALEFILES)
192-
@echo
193196
@echo "Vale is finished; look for any errors in the above output."
197+
@echo
194198

195199
.PHONY: html_meta
196200
html_meta: deps ## Add meta data headers to all Markdown pages
@@ -201,6 +205,7 @@ doctest: deps
201205
cd $(DOCS_DIR) && $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
202206
@echo "Testing of doctests in the sources finished, look at the " \
203207
"results in $(BUILDDIR)/doctest/output.txt."
208+
@echo
204209

205210
.PHONY: test
206211
test: clean linkcheckbroken ## Clean docs build, then run linkcheckbroken

0 commit comments

Comments
 (0)