Skip to content

Commit

Permalink
Move API things back to docs/*, fix Makefile
Browse files Browse the repository at this point in the history
  • Loading branch information
sneridagh committed Feb 17, 2025
1 parent 638e66c commit 34fffc6
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 1 deletion.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
# symlinked from submodule
docs/plone.api
docs/plone.restapi
docs/registry
docs/volto

# editor files
Expand Down
8 changes: 7 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,13 @@ docs/volto: ## Setup Volto docs
@echo
@echo "Documentation of volto initialized."

docs/registry: ## Setup @plone/registry docs
ln -sfn ../submodules/volto/packages/registry/docs ./docs/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/plone.restapi docs/plone.api docs/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
Expand Down Expand Up @@ -211,6 +216,7 @@ livehtml: deps ## Rebuild Sphinx documentation on changes, with live-reload in
--watch volto \
--watch plone.api \
--watch plone.restapi \
--watch registry \
-b html . "$(BUILDDIR)/html" $(SPHINXOPTS) $(O)

.PHONY: rtd-pr-preview
Expand Down
9 changes: 9 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,15 @@ contributing/index
% plone.restapi/docs/source/index
% backend/index

```{toctree}
:caption: API
:maxdepth: 1
:hidden: true
docs/registry
docs/plone.restapi/docs/index
docs/plone.api/index
```

```{toctree}
:caption: Appendices
Expand Down

0 comments on commit 34fffc6

Please sign in to comment.