Skip to content

Commit fb27598

Browse files
authored
Merge branch '6.0' into home-page-UI
2 parents 777f253 + a037cec commit fb27598

File tree

2 files changed

+30
-26
lines changed

2 files changed

+30
-26
lines changed

.gitignore

-3
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,5 @@ docs/plone.api
1111
docs/plone.restapi
1212
docs/volto
1313

14-
# created on first make command
15-
plone.api-install
16-
1714
# editor files
1815
.vscode

Makefile

+30-23
Original file line numberDiff line numberDiff line change
@@ -35,160 +35,166 @@ 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

55-
.PHONY: install-api
56-
install-api: docs/plone.api
55+
venv/plone.api-install: docs/plone.api
56+
touch venv/plone.api-install
5757
venv/bin/pip install plone.api -c submodules/plone.api/constraints.txt
5858
venv/bin/pip install --no-deps -e submodules/plone.api/"[test]"
59+
@echo "plone.api installed."
60+
@echo
5961

6062
docs/plone.restapi: ## Setup plone.restapi docs
6163
git submodule init
6264
git submodule update
6365
ln -s ../submodules/plone.restapi ./docs/plone.restapi
64-
@echo
6566
@echo "Documentation of plone.restapi initialized."
67+
@echo
6668

6769
docs/volto: ## Setup Volto docs
6870
git submodule init
6971
git submodule update
7072
ln -s ../submodules/volto/docs/source ./docs/volto
71-
@echo
7273
@echo "Documentation of volto initialized."
74+
@echo
7375

7476
.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.
7678

7779
.PHONY: html
7880
html: deps ## Build html
7981
cd $(DOCS_DIR) && $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
80-
@echo
8182
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
83+
@echo
8284

8385
.PHONY: manual
8486
manual: deps
8587
cd $(DOCS_DIR) && $(SPHINXBUILD) -b html -t manual . $(BUILDDIR)/manual
88+
@echo "Build finished. The manual pages are in $(BUILDDIR)/manual."
89+
@echo
8690

8791
.PHONY: dirhtml
8892
dirhtml: deps
8993
cd $(DOCS_DIR) && $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
90-
@echo
9194
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
95+
@echo
9296

9397
.PHONY: singlehtml
9498
singlehtml: deps
9599
cd $(DOCS_DIR) && $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
96-
@echo
97100
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
101+
@echo
98102

99103
.PHONY: pickle
100104
pickle: deps
101105
cd $(DOCS_DIR) && $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
102-
@echo
103106
@echo "Build finished; now you can process the pickle files."
107+
@echo
104108

105109
.PHONY: json
106110
json: deps
107111
cd $(DOCS_DIR) && $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
108-
@echo
109112
@echo "Build finished; now you can process the JSON files."
113+
@echo
110114

111115
.PHONY: htmlhelp
112116
htmlhelp: deps
113117
cd $(DOCS_DIR) && $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
114-
@echo
115118
@echo "Build finished; now you can run HTML Help Workshop with the" \
116119
".hhp project file in $(BUILDDIR)/htmlhelp."
120+
@echo
117121

118122
.PHONY: epub
119123
epub: deps
120124
cd $(DOCS_DIR) && $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
121-
@echo
122125
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
126+
@echo
123127

124128
.PHONY: latex
125129
latex: deps
126130
cd $(DOCS_DIR) && $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
127-
@echo
128131
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
129132
@echo "Run \`make' in that directory to run these through (pdf)latex" \
130133
"(use \`make latexpdf' here to do that automatically)."
134+
@echo
131135

132136
.PHONY: latexpdf
133137
latexpdf: deps
134138
cd $(DOCS_DIR) && $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
135139
@echo "Running LaTeX files through pdflatex..."
136140
$(MAKE) -C $(BUILDDIR)/latex all-pdf
137141
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
142+
@echo
138143

139144
.PHONY: text
140145
text: deps
141146
cd $(DOCS_DIR) && $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
142-
@echo
143147
@echo "Build finished. The text files are in $(BUILDDIR)/text."
148+
@echo
144149

145150
.PHONY: man
146151
man: deps
147152
cd $(DOCS_DIR) && $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
148-
@echo
149153
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
154+
@echo
150155

151156
.PHONY: texinfo
152157
texinfo: deps
153158
cd $(DOCS_DIR) && $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
154-
@echo
155159
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
156160
@echo "Run \`make' in that directory to run these through makeinfo" \
157161
"(use \`make info' here to do that automatically)."
162+
@echo
158163

159164
.PHONY: info
160165
info: deps
161166
cd $(DOCS_DIR) && $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
162167
@echo "Running Texinfo files through makeinfo..."
163168
make -C $(BUILDDIR)/texinfo info
164169
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
170+
@echo
165171

166172
.PHONY: changes
167173
changes: deps
168174
cd $(DOCS_DIR) && $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
169-
@echo
170175
@echo "The overview file is in $(BUILDDIR)/changes."
176+
@echo
171177

172178
.PHONY: linkcheck
173179
linkcheck: deps ## Run linkcheck
174180
cd $(DOCS_DIR) && $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
175-
@echo
176181
@echo "Link check complete; look for any errors in the above output " \
177182
"or in $(BUILDDIR)/linkcheck/ ."
183+
@echo
178184

179185
.PHONY: linkcheckbroken
180186
linkcheckbroken: deps ## Run linkcheck and show only broken links
181187
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
183188
@echo "Link check complete; look for any errors in the above output " \
184189
"or in $(BUILDDIR)/linkcheck/ ."
190+
@echo
185191

186192
.PHONY: vale
187193
vale: deps ## Run Vale style, grammar, and spell checks
188194
venv/bin/vale sync
189195
venv/bin/vale --no-wrap $(VALEOPTS) $(VALEFILES)
190-
@echo
191196
@echo "Vale is finished; look for any errors in the above output."
197+
@echo
192198

193199
.PHONY: html_meta
194200
html_meta: deps ## Add meta data headers to all Markdown pages
@@ -199,6 +205,7 @@ doctest: deps
199205
cd $(DOCS_DIR) && $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
200206
@echo "Testing of doctests in the sources finished, look at the " \
201207
"results in $(BUILDDIR)/doctest/output.txt."
208+
@echo
202209

203210
.PHONY: test
204211
test: clean linkcheckbroken ## Clean docs build, then run linkcheckbroken

0 commit comments

Comments
 (0)