Skip to content

Commit 9806dfd

Browse files
committed
Add volto docs submodule
1 parent 127b6ce commit 9806dfd

File tree

5 files changed

+28
-1
lines changed

5 files changed

+28
-1
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,5 @@
88
package-lock.json
99
pyvenv.cfg
1010
/_build
11+
*~
12+
lib64

.gitmodules

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[submodule "submodules/volto"]
2+
path = submodules/volto
3+
url = [email protected]:plone/volto.git

Makefile

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
# Makefile for Sphinx documentation
22
#
33

4+
# Now we can activate virtualenv
5+
SHELL=bash
6+
.DEFAULT_GOAL = all
7+
48
# You can set these variables from the command line.
59
SPHINXOPTS =
610
SPHINXBUILD = sphinx-build
@@ -35,8 +39,12 @@ build: ## Set up training: Install requirements
3539
@echo "Please activate your Python virtual environment with"
3640
@echo "source bin/activate"
3741

42+
bin/python: build
43+
@echo
44+
3845
.PHONY: html
39-
html: ## Build html
46+
html: bin/python # Build html
47+
source bin/activate; \
4048
cd $(DOCS_DIR) && $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
4149
@echo
4250
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
@@ -195,3 +203,15 @@ livehtml: ## Rebuild Sphinx documentation on changes, with live-reload in the b
195203

196204
.PHONY: all
197205
all: clean spellcheck linkcheck html ## Run checks and build html
206+
207+
.PHONY: activate
208+
activate:
209+
210+
submodules/volto:
211+
# git submodule add [email protected]:plone/volto.git submodules/volto
212+
git submodule init
213+
ln -s ../submodules/volto/docs/source ./docs/volto
214+
215+
.PHONY: serve-docs
216+
serve-docs: ## Start an HTTP server for docs
217+
python -m http.server --directory ./_build/html

docs/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ html_meta:
1616
1717
backend/index
1818
classic-ui/index
19+
volto/plone6index
1920
contributing/index
2021
```
2122

submodules/volto

Submodule volto added at 609913d

0 commit comments

Comments
 (0)