diff --git a/.gitignore b/.gitignore index a825459902..c1f13cfce8 100644 --- a/.gitignore +++ b/.gitignore @@ -7,8 +7,9 @@ /styles/Microsoft # symlinked from submodule -docs/plone.api -docs/plone.restapi +docs/api/plone.api +docs/api/plone.restapi +docs/api/registry docs/volto # editor files diff --git a/Makefile b/Makefile index a643b8d953..9cd0efab50 100644 --- a/Makefile +++ b/Makefile @@ -45,30 +45,37 @@ venv/bin/python: ## Setup up Python virtual environment and install requirement @echo @echo "Installation of requirements completed." -docs/plone.api: ## Setup plone.api docs +docs/api/plone.api: ## Setup plone.api docs git submodule init git submodule update venv/bin/pip install -e submodules/plone.api/"[test]" - ln -s ../submodules/plone.api/docs ./docs/plone.api + ln -sfn ../../submodules/plone.api/docs ./docs/api/plone.api @echo @echo "Documentation of plone.api initialized." -docs/plone.restapi: ## Setup plone.restapi docs +docs/api/plone.restapi: ## Setup plone.restapi docs git submodule init git submodule update - ln -s ../submodules/plone.restapi ./docs/plone.restapi + ln -sfn ../../submodules/plone.restapi ./docs/api/plone.restapi @echo @echo "Documentation of plone.restapi initialized." docs/volto: ## Setup Volto docs git submodule init git submodule update - ln -s ../submodules/volto/docs/source ./docs/volto + ln -sfn ../submodules/volto/docs/source ./docs/volto @echo @echo "Documentation of volto initialized." +docs/api/plone-registry: ## Setup @plone/registry docs + git submodule init + git submodule update + ln -sfn ../../submodules/volto/packages/registry/docs ./docs/api/registry + @echo + @echo "Documentation of @plone/registry initialized." + .PHONY: deps -deps: venv/bin/python docs/volto docs/plone.restapi docs/plone.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. +deps: venv/bin/python docs/volto docs/api/plone.restapi docs/api/plone.api docs/api/plone-registry ## 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. .PHONY: html @@ -209,8 +216,9 @@ livehtml: deps ## Rebuild Sphinx documentation on changes, with live-reload in --ignore "*.swp" \ --port 8050 \ --watch volto \ - --watch plone.api \ - --watch plone.restapi \ + --watch api/plone.api \ + --watch api/plone.restapi \ + --watch api/registry \ -b html . "$(BUILDDIR)/html" $(SPHINXOPTS) $(O) .PHONY: rtd-pr-preview diff --git a/docs/api/.gitkeep b/docs/api/.gitkeep new file mode 100644 index 0000000000..e69de29bb2 diff --git a/docs/conf.py b/docs/conf.py index b6c578df12..d0fa82daef 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -203,8 +203,8 @@ "attributes": { "target": "_blank", "rel": "noopener me", - "class": "nav-link custom-fancy-css" - } + "class": "nav-link custom-fancy-css", + }, }, { "name": "Mastodon", @@ -214,8 +214,8 @@ "attributes": { "target": "_blank", "rel": "noopener me", - "class": "nav-link custom-fancy-css" - } + "class": "nav-link custom-fancy-css", + }, }, { "name": "YouTube", @@ -225,8 +225,8 @@ "attributes": { "target": "_blank", "rel": "noopener me", - "class": "nav-link custom-fancy-css" - } + "class": "nav-link custom-fancy-css", + }, }, { "name": "X (formerly Twitter)", @@ -236,8 +236,8 @@ "attributes": { "target": "_blank", "rel": "noopener me", - "class": "nav-link custom-fancy-css" - } + "class": "nav-link custom-fancy-css", + }, }, ], "logo": { @@ -436,6 +436,7 @@ # -- Configuration for source_replacements extension ----------------------- + # An extension that allows replacements for code blocks that # are not supported in `rst_epilog` or other substitutions. # https://stackoverflow.com/a/56328457/2214933 @@ -451,6 +452,7 @@ def source_replace(app, docname, source): "{PLONE_BACKEND_MINOR_VERSION}": "6.0", } + # Finally, configure app attributes. def setup(app): app.add_config_value("source_replacements", {}, True) diff --git a/docs/index.md b/docs/index.md index eac118d553..c1104f3151 100644 --- a/docs/index.md +++ b/docs/index.md @@ -45,6 +45,14 @@ contributing/index % plone.restapi/docs/source/index % backend/index +```{toctree} +:caption: API +:maxdepth: 2 +:hidden: + +api/registry/index +api/plone.restapi/docs/source/index +``` ```{toctree} :caption: Appendices