Integrate plone.api documentation in /backend

Author: ksuess

.gitignore

@@ -11,3 +11,4 @@ pyvenv.cfg
 # symlinked from submodule
 docs/volto
 docs/plone.restapi
+docs/plone.api

.gitmodules

@@ -6,3 +6,7 @@
 	path = submodules/plone.restapi
 	url = https://github.com/plone/plone.restapi.git
 	branch = master
+[submodule "submodules/plone.api"]
+	path = submodules/plone.api
+	url = https://github.com/plone/plone.api.git
+	branch = integration-in-plone-docs-6

Makefile

@@ -48,8 +48,16 @@ docs/restapi:
 	git submodule update; \
 	ln -s "../submodules/plone.restapi" "./docs/plone.restapi"
 
+docs/plone.api:
+	git submodule init; \
+	git submodule update; \
+	bin/pip install -e submodules/plone.api[test]; \
+	ln -s "../submodules/plone.api/docs" "./docs/plone.api"
+	@echo
+	@echo "Documentation of plone.api initialized."
+
 .PHONY: deps
-deps: bin/python docs/volto docs/restapi  ## Create Python virtual environment, install requirements, initialize or update the volto and plone.restapi submodules, and finally create symlinks to the documentation source.
+deps: bin/python docs/volto docs/plone.restapi docs/plone.api  ## Create Python virtual environment, install requirements, initialize or update the volto and plone.restapi submodules, and finally create symlinks to the documentation source.
 
 .PHONY: html
 html: deps  ## Build html
@@ -216,6 +224,7 @@ netlify:
 	git submodule update; \
 	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"
 	cd $(DOCS_DIR) && sphinx-build -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
 	make storybook
 

docs/backend/index.md

@@ -26,7 +26,7 @@ security
 workflows
 search
 zodb
-plone-api
+../plone.api/index.md
 plone-restapi
 sending-email
 upgrading/index

docs/backend/plone-api.md

@@ -52,6 +52,11 @@
     "sphinxcontrib.httpexample",
     "sphinxcontrib.spelling",
     "sphinxext.opengraph",
+    # plone.api
+    # 'sphinx.ext.doctest',
+    # 'sphinx.ext.coverage',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.autosummary',
 ]
 
 

docs/conf.py

@@ -196,8 +196,9 @@ These branches may change as we get closer to a production release.
 
     ```shell
     # choose one
-    cd submodules/plone.restapi
     cd submodules/volto
+    cd submodules/plone.restapi
+    cd submodules/plone.api
     ```
 
 1.  Update the submodule, and sync your local development branch with its remote.
@@ -206,12 +207,15 @@ These branches may change as we get closer to a production release.
     ```shell
     git submodule update
 
-    # For plone.restapi
+    # For volto
     git checkout master
 
-    # For volto
+    # For plone.restapi
     git checkout master
 
+    # For plone.api
+    git checkout integration-in-plone-docs-6
+
     git pull
     ```
 
@@ -246,13 +250,17 @@ These branches may change as we get closer to a production release.
     ```shell
     cd ../..
 
+    # For volto
+    git add submodules/volto
+    git commit -m "Update submodules/volto tip"
+
     # For plone.restapi
     git add submodules/plone.restapi
     git commit -m "Update submodules/plone.restapi tip"
 
-    # For volto
-    git add submodules/volto
-    git commit -m "Update submodules/volto tip"
+    # For plone.api
+    git add submodules/plone.api
+    git commit -m "Update submodules/plone.api tip"
 
     git push
     ```