mirror of
https://github.com/nlohmann/json.git
synced 2026-10-10 16:37:14 +00:00
Niels Lohmann
07ec1a4e31
Replace the hand-maintained docs/docset/docSet.sql and the bash/sed Makefile recipe with docs/docset/generate_docset.py: - The search index is generated from the mkdocs.yml nav and each page's H1 and declaration. Pages documenting several entities (e.g. JSON_HAS_CPP_11..26) get one entry per name; all non-API pages become guides. New API pages no longer need a manual entry. - Page titles are set from the index names. - The docset is self-contained: the mermaid loader no longer points to https://json.nlohmann.me/assets/..., the repository widget no longer queries api.github.com, remaining remote images are downloaded, and the build fails if any remote resource load remains. - The CSS that hides the site navigation now uses Material's classes; the element selectors lost against them, so the header was shown. check_structure.py's docset check is replaced by running the generator in `make style_check`. Signed-off-by: Niels Lohmann <mail@nlohmann.me>
58 lines
1.8 KiB
Makefile
58 lines
1.8 KiB
Makefile
# The MkDocs 2.0 banners of Material for MkDocs and ProperDocs (via mkdocs-redirects) are printed to stderr, not
|
|
# logged, so they do not affect --strict; silence them anyway.
|
|
export NO_MKDOCS_2_WARNING := true
|
|
export DISABLE_MKDOCS_2_WARNING := true
|
|
|
|
# serve the site locally
|
|
serve: style_check
|
|
venv/bin/mkdocs serve
|
|
|
|
serve_dirty: style_check
|
|
venv/bin/mkdocs serve --dirtyreload
|
|
|
|
# This target is used in the CI (ci_test_build_documentation).
|
|
# This target is used by the docset Makefile.
|
|
build: style_check
|
|
venv/bin/mkdocs build --strict
|
|
|
|
style_check:
|
|
@cd docs ; ../venv/bin/python3 ../scripts/check_structure.py
|
|
@venv/bin/python3 ../docset/generate_docset.py list > /dev/null
|
|
|
|
# check that all Mermaid diagrams parse (needs Node.js)
|
|
# This target is used in the CI (ci_test_documentation_mermaid).
|
|
check_mermaid:
|
|
npm ci --prefix scripts/mermaid --ignore-scripts --no-audit --no-fund
|
|
node scripts/mermaid/check_mermaid.mjs docs
|
|
|
|
# check the links in the documentation files in docs/mkdocs
|
|
link_check:
|
|
ENABLED_HTMLPROOFER=true venv/bin/mkdocs build
|
|
|
|
# check the links in all other Markdown files
|
|
link_check_markdowns:
|
|
npx markdown-link-check --progress --alive 200,429 ../../README.md ../../FILES.md ../../.github/*.md
|
|
|
|
# publish site to GitHub pages (not working in GitHub Actions; need special action)
|
|
publish:
|
|
venv/bin/mkdocs gh-deploy --clean --force
|
|
|
|
# install a Python virtual environment
|
|
# This target is used by the docset Makefile.
|
|
install_venv: requirements.txt
|
|
python3 -mvenv venv
|
|
venv/bin/pip install --upgrade pip
|
|
venv/bin/pip install -r requirements.txt
|
|
|
|
# uninstall the virtual environment
|
|
uninstall_venv:
|
|
rm -fr venv
|
|
|
|
update_requirements:
|
|
rm -fr venv_small
|
|
python3 -mvenv venv_small
|
|
venv_small/bin/pip3 install pur
|
|
venv_small/bin/pur -r requirements.txt
|
|
rm -fr venv_small venv
|
|
make install_venv
|