Skip to content

Commit 1dbbd8d

Browse files
committed
Integrate plone.api documentation in /backend
1 parent 0707034 commit 1dbbd8d

File tree

8 files changed

+36
-20
lines changed

8 files changed

+36
-20
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,4 @@ pyvenv.cfg
1111
# symlinked from submodule
1212
docs/volto
1313
docs/plone.restapi
14+
docs/plone.api

.gitmodules

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,7 @@
66
path = submodules/plone.restapi
77
url = https://github.com/plone/plone.restapi.git
88
branch = master
9+
[submodule "submodules/plone.api"]
10+
path = submodules/plone.api
11+
url = https://github.com/plone/plone.api.git
12+
branch = integration-in-plone-docs-6

Makefile

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,16 @@ docs/restapi:
4848
git submodule update; \
4949
ln -s "../submodules/plone.restapi" "./docs/plone.restapi"
5050

51+
docs/plone.api:
52+
git submodule init; \
53+
git submodule update; \
54+
bin/pip install -e submodules/plone.api[test]; \
55+
ln -s "../submodules/plone.api/docs" "./docs/plone.api"
56+
@echo
57+
@echo "Documentation of plone.api initialized."
58+
5159
.PHONY: deps
52-
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.
60+
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.
5361

5462
.PHONY: html
5563
html: deps ## Build html
@@ -216,6 +224,7 @@ netlify:
216224
git submodule update; \
217225
ln -s ../submodules/volto/docs/source ./docs/volto
218226
ln -s "../submodules/plone.restapi" "./docs/plone.restapi"
227+
ln -s "../submodules/plone.api/docs" "./docs/plone.api"
219228
cd $(DOCS_DIR) && sphinx-build -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
220229
make storybook
221230

docs/backend/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ security
2626
workflows
2727
search
2828
zodb
29-
plone-api
29+
../plone.api/index.md
3030
plone-restapi
3131
sending-email
3232
upgrading/index

docs/backend/plone-api.md

Lines changed: 0 additions & 12 deletions
This file was deleted.

docs/conf.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,11 @@
5252
"sphinxcontrib.httpexample",
5353
"sphinxcontrib.spelling",
5454
"sphinxext.opengraph",
55+
# plone.api
56+
# 'sphinx.ext.doctest',
57+
# 'sphinx.ext.coverage',
58+
'sphinx.ext.viewcode',
59+
'sphinx.ext.autosummary',
5560
]
5661

5762

docs/contributing/index.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -196,8 +196,9 @@ These branches may change as we get closer to a production release.
196196
197197
```shell
198198
# choose one
199-
cd submodules/plone.restapi
200199
cd submodules/volto
200+
cd submodules/plone.restapi
201+
cd submodules/plone.api
201202
```
202203
203204
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.
206207
```shell
207208
git submodule update
208209
209-
# For plone.restapi
210+
# For volto
210211
git checkout master
211212
212-
# For volto
213+
# For plone.restapi
213214
git checkout master
214215
216+
# For plone.api
217+
git checkout integration-in-plone-docs-6
218+
215219
git pull
216220
```
217221
@@ -246,13 +250,17 @@ These branches may change as we get closer to a production release.
246250
```shell
247251
cd ../..
248252
253+
# For volto
254+
git add submodules/volto
255+
git commit -m "Update submodules/volto tip"
256+
249257
# For plone.restapi
250258
git add submodules/plone.restapi
251259
git commit -m "Update submodules/plone.restapi tip"
252260
253-
# For volto
254-
git add submodules/volto
255-
git commit -m "Update submodules/volto tip"
261+
# For plone.api
262+
git add submodules/plone.api
263+
git commit -m "Update submodules/plone.api tip"
256264
257265
git push
258266
```

submodules/plone.api

Submodule plone.api added at 6902abf

0 commit comments

Comments
 (0)