Skip to content
Merged
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
16 changes: 13 additions & 3 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -226,15 +226,25 @@ setup-softhsm:
softhsm2-util --init-token --slot 0 --label 'ForFabric' --pin 98765432 --so-pin 1234 || true

.PHONY: generate-docs
generate-docs: $(python_venv_activate)
generate-docs: install-mkdocs $(python_venv_activate)
. '$(python_venv_activate)' && \
cd '$(base_dir)' && \
python -m pip install --quiet --require-virtualenv --disable-pip-version-check --requirement requirements.txt && \
TZ=UTC mkdocs build --strict

$(python_venv_activate):
python -m venv '$(python_venv_dir)'

.PHONY: install-mkdocs
install-mkdocs: $(python_venv_activate)
. '$(python_venv_activate)' && \
cd '$(base_dir)' && \
python -m pip install --quiet --require-virtualenv --disable-pip-version-check --requirement requirements.txt

.PHONY: serve-docs
serve-docs: install-mkdocs $(python_venv_activate)
. '$(python_venv_activate)' && \
cd '$(base_dir)' && \
TZ=UTC mkdocs serve --strict

.PHONY: generate-docs-node
generate-docs-node:
cd '$(node_dir)' && \
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@ The following Makefile targets are available:
- `make test` - run all tests
- `make format` - fix all code formatting
- `make generate-docs` - generate documentation site content
- `make serve-docs` - serve the documentation site content on a local development server
- `make generate-docs-node` - generate Node API documentation
- `make generate-docs-java` - generate Java API documentation
- `make clean` - remove all generated content
Expand Down
2 changes: 2 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ theme:
toggle:
icon: material/brightness-4
name: Switch to system preference
features:
- toc.integrate
extra:
social:
- icon: octicons/comment-discussion-16
Expand Down