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>
35 lines
1.1 KiB
Makefile
35 lines
1.1 KiB
Makefile
SHELL=/usr/bin/env bash
|
|
PYTHON=../mkdocs/venv/bin/python3
|
|
|
|
.PHONY: all
|
|
all: JSON_for_Modern_C++.tgz
|
|
|
|
# generate the search index (the docset target does this itself, this is
|
|
# only handy for inspecting the index)
|
|
docSet.dsidx: generate_docset.py
|
|
$(PYTHON) generate_docset.py index docSet.dsidx
|
|
|
|
# build the documentation and turn it into a self-contained docset
|
|
.PHONY: JSON_for_Modern_C++.docset
|
|
JSON_for_Modern_C++.docset:
|
|
$(MAKE) install_venv -C ../mkdocs
|
|
$(MAKE) build -C ../mkdocs
|
|
$(PYTHON) generate_docset.py docset ../mkdocs/site .
|
|
|
|
.PHONY: JSON_for_Modern_C++.tgz
|
|
JSON_for_Modern_C++.tgz: JSON_for_Modern_C++.docset
|
|
$(PYTHON) generate_docset.py tgz .
|
|
|
|
# install docset for Zeal documentation browser (https://zealdocs.org/)
|
|
.PHONY: install_docset_zeal
|
|
install_docset_zeal: JSON_for_Modern_C++.docset
|
|
docset_root=$${XDG_DATA_HOME:-$$HOME/.local/share}/Zeal/Zeal/docsets; \
|
|
rm -rf $$docset_root/JSON_for_Modern_C++.docset; \
|
|
mkdir -p $$docset_root; \
|
|
cp -r JSON_for_Modern_C++.docset $$docset_root/
|
|
|
|
.PHONY: clean
|
|
clean:
|
|
rm -f docSet.dsidx
|
|
rm -fr JSON_for_Modern_C++.docset JSON_for_Modern_C++.tgz
|