Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
docs/plone.api
docs/plone.restapi
docs/volto
docs/diazo

# editor files
.vscode
4 changes: 4 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,7 @@
path = submodules/plone.api
url = https://github.com/plone/plone.api.git
branch = main
[submodule "submodules/diazo"]
path = submodules/diazo
url = https://github.com/plone/diazo.git
branch = main
12 changes: 11 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ distclean: clean ## Clean Python virtual environment and symlinks to submodules
rm docs/plone.api
rm docs/plone.restapi
rm docs/volto
rm docs/diazo
@echo "Cleaned Python virtual environment and symlinks to submodules."
@echo

Expand Down Expand Up @@ -73,6 +74,13 @@ docs/volto: ## Setup Volto docs
@echo "Documentation of volto initialized."
@echo

docs/diazo: ## Setup diazo docs
git submodule init
git submodule update
ln -s ../submodules/diazo/docs ./docs/diazo
@echo "Documentation of diazo initialized."
@echo

ln-seven: ## Toggle the symlink to Seven
rm docs/volto
ln -s ../submodules/volto/docs ./docs/volto
Expand All @@ -86,7 +94,7 @@ ln-volto: ## Toggle the symlink to Volto
@echo

.PHONY: deps
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.
deps: venv/bin/python docs/volto docs/plone.restapi docs/diazo venv/plone.api-install ## Create Python virtual environment, install requirements, initialize or update the volto, plone.restapi, diazo, and plone.api submodules, create symlinks to the source files, and finally install plone.api.

.PHONY: html
html: deps ## Build html
Expand Down Expand Up @@ -233,6 +241,7 @@ livehtml: deps ## Rebuild Sphinx documentation on changes, with live-reload in
--watch volto \
--watch plone.api \
--watch plone.restapi \
--watch diazo \
-b html . "$(BUILDDIR)/html" $(SPHINXOPTS) $(O)

.PHONY: rtd-pr-preview
Expand All @@ -246,6 +255,7 @@ rtd-pr-preview: ## Build pull request preview on Read the Docs
ln -s ../submodules/volto/docs/source ./docs/volto
ln -s ../submodules/plone.restapi ./docs/plone.restapi
ln -s ../submodules/plone.api/docs ./docs/plone.api
ln -s ../submodules/diazo/docs ./docs/diazo
cd $(DOCS_DIR) && sphinx-build -b html $(ALLSPHINXOPTS) ${READTHEDOCS_OUTPUT}/html/

.PHONY: storybook
Expand Down
1 change: 1 addition & 0 deletions docs/classic-ui/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ static-resources
template-global-variables
templates
theming/index
../diazo/index
tinymce-customization
viewlets
views
Expand Down
2 changes: 1 addition & 1 deletion docs/classic-ui/theming/diazo.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ Add a stanza in your {file}`rules.xml` file.

You can start with the provided {file}`rules.xml` file.

You can read about how to write your rules and their syntax in the [official Diazo documentation](https://docs.diazo.org/en/latest/basic.html).
You can read about how to write your rules and their syntax in the {doc}`Diazo documentation </diazo/index>`.

You will need to write your own rules to bring the dynamic content from Plone into the theme.

Expand Down
14 changes: 14 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,20 @@
"plone.restapi/styles",
"plone.restapi/var",
"volto/_inc/*",
"diazo/CHANGES.rst",
"diazo/CONTRIBUTING.rst",
"diazo/LICENSE.txt",
"diazo/MANIFEST.in",
"diazo/README.rst",
"diazo/pyproject.toml",
"diazo/setup.cfg",
"diazo/setup.py",
"diazo/tox.ini",
"diazo/examples",
"diazo/src",
"diazo/news",
"diazo/oldchanges.rst",
"diazo/TODO.txt",
]

suppress_warnings = [
Expand Down
6 changes: 4 additions & 2 deletions docs/contributing/documentation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,12 +69,13 @@ Plone documentation consists of several repositories.
- [`plone.api`](https://github.com/plone/plone.api)
- [`plone.restapi`](https://github.com/plone/plone.restapi)
- [`volto`](https://github.com/plone/volto)
- [`diazo`](https://github.com/plone/diazo)

[`documentation`](https://github.com/plone/documentation) is the primary repository.
When you {doc}`setup and build <setup-build>` the documentation, it will automatically pull in the other repositories via git submodules.

```{important}
We currently use the branches `plone/documentation@6.0`, `plone/plone.api@main`, `plone/plone.restapi@main`, and `plone/volto@main` as the default branches for developing Plone 6 Documentation.
We currently use the branches `plone/documentation@6.0`, `plone/plone.api@main`, `plone/plone.restapi@main`, `plone/volto@main`, and `plone/diazo@main` as the default branches for developing Plone 6 Documentation.
```


Expand Down Expand Up @@ -241,7 +242,7 @@ This section describes how to make contributions to files in the `plone/document

### Editing external package documentation

To edit documentation of imported external packages, including `plone/plone.api`, `plone/plone.restapi`, and `plone/volto`, the process is slightly different.
To edit documentation of imported external packages, including `plone/plone.api`, `plone/plone.restapi`, `plone/volto`, and `plone/diazo`, the process is slightly different.
Plone Documentation uses git submodules to manage multiple repositories.
You already imported the external repositories into the `plone/documentation` repository as described in {doc}`setup-build`.

Expand All @@ -252,6 +253,7 @@ You already imported the external repositories into the `plone/documentation` re
cd submodules/plone.api/docs
cd submodules/plone.restapi/docs/source
cd submodules/volto/docs/source
cd submodules/diazo/docs
```

1. Sync your local development branch with its remote.
Expand Down
4 changes: 4 additions & 0 deletions docs/contributing/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -206,6 +206,10 @@ Volto
: Plone 6 default frontend.
See {doc}`../volto/contributing/index`.

Diazo
: Theme engine for Plone.
See the [Diazo documentation](https://docs.diazo.org/).

(contributing-releases-label)=

## Releases
Expand Down
1 change: 1 addition & 0 deletions submodules/diazo
Submodule diazo added at 601caf