Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Integrate Mockup's documentation #1548

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,7 @@
path = submodules/plone.api
url = https://github.com/plone/plone.api.git
branch = master
[submodule "submodules/mockup"]
path = submodules/mockup
url = https://github.com/plone/mockup.git
branch = improve-docs
10 changes: 9 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,15 @@ docs/volto:
@echo
@echo "Documentation of volto initialized."

docs/mockup:
git submodule init; \
git submodule update; \
ln -s ../submodules/mockup ./docs/mockup
@echo
@echo "Documentation of mockup initialized."

.PHONY: deps
deps: 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: bin/python docs/volto docs/plone.restapi docs/plone.api docs/mockup ## Create Python virtual environment, install requirements, initialize or update the volto, plone.restapi, plone.api, and mockup submodules, and finally create symlinks to the source files.


.PHONY: html
Expand Down Expand Up @@ -235,6 +242,7 @@ netlify:
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/mockup ./docs/mockup
cd $(DOCS_DIR) && sphinx-build -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html && cp ./netlify_robots.txt $(BUILDDIR)/html/robots.txt

.PHONY: storybook
Expand Down
3 changes: 2 additions & 1 deletion docs/_templates/search.html
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,7 @@ <h1 id="search-documentation">{{ _('Search') }}</h1>
["classic-ui","Classic UI"],
["volto","Frontend"],
["contributing","Contributing"],
["mockup","Mockup"],
] %}
<div class="form-check">
<input class="form-check-input" type="radio" name="doc_section" id="doc_section_{{id}}" value="{{id}}">
Expand Down Expand Up @@ -133,4 +134,4 @@ <h1 id="search-documentation">{{ _('Search') }}</h1>
});
</script>

{% endblock %}
{% endblock %}
1 change: 1 addition & 0 deletions docs/classic-ui/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,4 +62,5 @@ theming/index
viewlets
views
whatsnew
../mockup/README.md
```
1 change: 1 addition & 0 deletions submodules/mockup
Submodule mockup added at 2f79bf
Loading