@@ -19,17 +19,17 @@ I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
1919
2020
2121# Add the following 'help' target to your Makefile
22- # And add help text after each target name starting with '#'
22+ # And add help text after each target name starting with '\#\ #'
2323.PHONY : help
2424help : # This help message
2525 @grep -E ' ^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST ) | sort | awk ' BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
2626
2727.PHONY : clean
28- clean : # Clean docs build directory
28+ clean : # # Clean docs build directory
2929 cd $(DOCS_DIR ) && rm -rf $(BUILDDIR ) /
3030
3131.PHONY : distclean
32- distclean : # Clean docs build directory and Python virtual environment
32+ distclean : # # Clean docs build directory and Python virtual environment
3333 cd $(DOCS_DIR ) && rm -rf $(BUILDDIR ) /
3434 rm -rf ./bin/ ./lib/ ./lib64 ./include ./pyvenv.cfg
3535
@@ -45,10 +45,10 @@ docs/volto:
4545 ln -s ../submodules/volto/docs/source ./docs/volto
4646
4747.PHONY : deps
48- deps : bin/python docs/volto # Create Python virtual environment, install requirements, pull in Volto submodule
48+ deps : bin/python docs/volto # # Create Python virtual environment, install requirements, pull in Volto submodule
4949
5050.PHONY : html
51- html : deps # Build html
51+ html : deps # # Build html
5252 cd $(DOCS_DIR ) && $(SPHINXBUILD ) -b html $(ALLSPHINXOPTS ) $(BUILDDIR ) /html
5353 @echo
5454 @echo " Build finished. The HTML pages are in $( BUILDDIR) /html."
@@ -163,28 +163,28 @@ changes: deps
163163 @echo " The overview file is in $( BUILDDIR) /changes."
164164
165165.PHONY : linkcheck
166- linkcheck : deps # Run linkcheck
166+ linkcheck : deps # # Run linkcheck
167167 cd $(DOCS_DIR ) && $(SPHINXBUILD ) -b linkcheck $(ALLSPHINXOPTS ) $(BUILDDIR ) /linkcheck
168168 @echo
169169 @echo " Link check complete; look for any errors in the above output " \
170170 " or in $( BUILDDIR) /linkcheck/ ."
171171
172172.PHONY : linkcheckbroken
173- linkcheckbroken : deps # Run linkcheck and show only broken links
173+ linkcheckbroken : deps # # Run linkcheck and show only broken links
174174 cd $(DOCS_DIR ) && $(SPHINXBUILD ) -b linkcheck $(ALLSPHINXOPTS ) $(BUILDDIR ) /linkcheck | GREP_COLORS=' 0;31' egrep -wi broken --color=auto
175175 @echo
176176 @echo " Link check complete; look for any errors in the above output " \
177177 " or in $( BUILDDIR) /linkcheck/ ."
178178
179179.PHONY : spellcheck
180- spellcheck : deps # Run spellcheck
180+ spellcheck : deps # # Run spellcheck
181181 cd $(DOCS_DIR ) && LANGUAGE=$* $(SPHINXBUILD ) -b spelling -j 4 $(ALLSPHINXOPTS ) $(BUILDDIR ) /spellcheck/$*
182182 @echo
183183 @echo " Spellcheck is finished; look for any errors in the above output " \
184184 " or in $( BUILDDIR) /spellcheck/ ."
185185
186186.PHONY : html_meta
187- html_meta : deps # Add meta data headers to all Markdown pages
187+ html_meta : deps # # Add meta data headers to all Markdown pages
188188 python ./docs/addMetaData.py
189189
190190.PHONY : doctest
@@ -194,16 +194,16 @@ doctest: deps
194194 " results in $( BUILDDIR) /doctest/output.txt."
195195
196196.PHONY : test
197- test : clean linkcheck spellcheck # Clean docs build, then run linkcheck, spellcheck
197+ test : clean linkcheck spellcheck # # Clean docs build, then run linkcheck, spellcheck
198198
199199.PHONY : deploy
200200deploy : clean html
201201
202202.PHONY : livehtml
203- livehtml : deps # Rebuild Sphinx documentation on changes, with live-reload in the browser
203+ livehtml : deps # # Rebuild Sphinx documentation on changes, with live-reload in the browser
204204 cd " $( DOCS_DIR) " && ${SPHINXAUTOBUILD} \
205205 --ignore " *.swp" \
206206 -b html . " $( BUILDDIR) /html" $(SPHINXOPTS ) $(O )
207207
208208.PHONY : all
209- all : clean spellcheck linkcheck html # Clean docs build, then run linkcheck and spellcheck, and build html
209+ all : clean spellcheck linkcheck html # # Clean docs build, then run linkcheck and spellcheck, and build html
0 commit comments