From 16182f5d16416a8d170ad142f0438bad4d978911 Mon Sep 17 00:00:00 2001 From: Manik Khajuria Date: Sat, 7 Feb 2026 17:05:02 +0530 Subject: [PATCH] Include diazo documentation --- .gitignore | 1 + .gitmodules | 4 ++++ Makefile | 12 +++++++++++- docs/classic-ui/index.md | 1 + docs/classic-ui/theming/diazo.md | 2 +- docs/conf.py | 14 ++++++++++++++ docs/contributing/documentation/index.md | 6 ++++-- docs/contributing/index.md | 4 ++++ submodules/diazo | 1 + 9 files changed, 41 insertions(+), 4 deletions(-) create mode 160000 submodules/diazo diff --git a/.gitignore b/.gitignore index a82545990..8dc3eb6af 100644 --- a/.gitignore +++ b/.gitignore @@ -10,6 +10,7 @@ docs/plone.api docs/plone.restapi docs/volto +docs/diazo # editor files .vscode diff --git a/.gitmodules b/.gitmodules index 0e7410d05..868a79554 100644 --- a/.gitmodules +++ b/.gitmodules @@ -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 diff --git a/Makefile b/Makefile index 492f479d4..4dd4e313c 100644 --- a/Makefile +++ b/Makefile @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 diff --git a/docs/classic-ui/index.md b/docs/classic-ui/index.md index 085348419..60cda71fa 100644 --- a/docs/classic-ui/index.md +++ b/docs/classic-ui/index.md @@ -34,6 +34,7 @@ static-resources template-global-variables templates theming/index +../diazo/index tinymce-customization viewlets views diff --git a/docs/classic-ui/theming/diazo.md b/docs/classic-ui/theming/diazo.md index 4ca5f78f4..b509213b3 100644 --- a/docs/classic-ui/theming/diazo.md +++ b/docs/classic-ui/theming/diazo.md @@ -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 `. You will need to write your own rules to bring the dynamic content from Plone into the theme. diff --git a/docs/conf.py b/docs/conf.py index ebabdc027..1cdd1ba84 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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 = [ diff --git a/docs/contributing/documentation/index.md b/docs/contributing/documentation/index.md index 820eff0eb..a797f2081 100644 --- a/docs/contributing/documentation/index.md +++ b/docs/contributing/documentation/index.md @@ -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 ` 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. ``` @@ -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`. @@ -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. diff --git a/docs/contributing/index.md b/docs/contributing/index.md index 7b9815954..dd2278a85 100644 --- a/docs/contributing/index.md +++ b/docs/contributing/index.md @@ -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 diff --git a/submodules/diazo b/submodules/diazo new file mode 160000 index 000000000..601caffa6 --- /dev/null +++ b/submodules/diazo @@ -0,0 +1 @@ +Subproject commit 601caffa6fbd5d9d9d2b9c26b00f3eb355c08d2b