mirror of
https://github.com/nlohmann/json.git
synced 2026-10-06 06:30:31 +00:00
Niels Lohmann
45dc218a13
The docset Makefile's list_missing_pages ran one sqlite3 query per mkdocs page, and list_removed_paths nested a loop over all mkdocs pages inside a loop over all docset index paths (O(n*m) shell iteration). Issue #5718 item 5 suggested removing or reducing these targets once #5638's check_docset() lands, but that PR is still open and covers only API pages and macros, not the full page set these targets check. Replace the loops with two sorted path lists (DOCSET_PAGE_PATHS from mkdocs' markdown sources, DOCSET_INDEX_PATHS from the built docset index) compared with a single comm(1) call each, verified to produce output identical to the old loops against the current docSet.dsidx. The sed expression used '#' as its delimiter, which GNU Make reads as a comment character even inside a variable assignment, truncating the line and orphaning the closing paren of $(shell ...) ("unterminated call to function 'shell': missing ')'"). Use '@' as the delimiter instead. Part of #5718 item 5 Signed-off-by: Niels Lohmann <mail@nlohmann.me>
79 lines
3.8 KiB
Makefile
79 lines
3.8 KiB
Makefile
SHELL=/usr/bin/env bash
|
|
SED ?= $(shell which gsed 2>/dev/null || which sed)
|
|
|
|
MKDOCS_PAGES=$(shell cd ../mkdocs/docs/ && find * -type f -name '*.md' | sort)
|
|
|
|
.PHONY: all
|
|
all: JSON_for_Modern_C++.tgz
|
|
|
|
docSet.dsidx: docSet.sql
|
|
# generate index
|
|
sqlite3 docSet.dsidx <docSet.sql
|
|
|
|
JSON_for_Modern_C++.docset: Info.plist docSet.dsidx
|
|
rm -fr JSON_for_Modern_C++.docset JSON_for_Modern_C++.tgz
|
|
mkdir -p JSON_for_Modern_C++.docset/Contents/Resources/Documents/
|
|
cp icon*.png JSON_for_Modern_C++.docset
|
|
cp Info.plist JSON_for_Modern_C++.docset/Contents
|
|
# build and copy documentation
|
|
$(MAKE) install_venv -C ../mkdocs
|
|
$(MAKE) build -C ../mkdocs
|
|
cp -r ../mkdocs/site/* JSON_for_Modern_C++.docset/Contents/Resources/Documents
|
|
# patch CSS to hide navigation items
|
|
echo -e "\n\nheader, footer, nav.md-tabs, nav.md-tabs--active, div.md-sidebar--primary, a.md-content__button { display: none; }" >> "$$(ls JSON_for_Modern_C++.docset/Contents/Resources/Documents/assets/stylesheets/main.*.min.css)"
|
|
# fix spacing
|
|
echo -e "\n\ndiv.md-sidebar div.md-sidebar--secondary, div.md-main__inner { top: 0; margin-top: 0 }" >> "$$(ls JSON_for_Modern_C++.docset/Contents/Resources/Documents/assets/stylesheets/main.*.min.css)"
|
|
# remove "JSON for Modern C++" from page titles (fallback)
|
|
find JSON_for_Modern_C++.docset/Contents/Resources/Documents -type f -exec $(SED) -i 's| - JSON for Modern C++</title>|</title>|' {} +
|
|
# replace page titles with name from index, if available
|
|
for page in $(MKDOCS_PAGES); do \
|
|
case "$$page" in \
|
|
*/index.md) path=$${page/\/index.md/} ;; \
|
|
*) path=$${page/.md/} ;; \
|
|
esac; \
|
|
title=$$(sqlite3 docSet.dsidx "SELECT name FROM searchIndex WHERE path='$$path/index.html'" | tr '\n' ',' | $(SED) -e 's/,/, /g' -e 's/, $$/\n/'); \
|
|
if [ "x$$title" != "x" ]; then \
|
|
$(SED) -i "s%<title>.*</title>%<title>$$title</title>%" "JSON_for_Modern_C++.docset/Contents/Resources/Documents/$$path/index.html"; \
|
|
fi \
|
|
done
|
|
# clean up
|
|
rm JSON_for_Modern_C++.docset/Contents/Resources/Documents/sitemap.*
|
|
# copy index
|
|
cp docSet.dsidx JSON_for_Modern_C++.docset/Contents/Resources/
|
|
|
|
JSON_for_Modern_C++.tgz: JSON_for_Modern_C++.docset
|
|
tar --exclude='.DS_Store' -cvzf JSON_for_Modern_C++.tgz JSON_for_Modern_C++.docset
|
|
|
|
# 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/
|
|
|
|
# both targets below compare the docset search index with the mkdocs page
|
|
# set. They share the same normalization (docs/foo/index.md and
|
|
# docs/foo.md both become foo/index.html, the URL mkdocs itself would
|
|
# give the page; the top-level index.md is excluded, as it is not part
|
|
# of the hand-curated docSet.sql) and use comm(1) on two sorted lists
|
|
# instead of running a sqlite3 query, or an O(n*m) nested shell loop,
|
|
# once per page.
|
|
DOCSET_INDEX_PATHS=$(shell sqlite3 docSet.dsidx "SELECT DISTINCT path FROM searchIndex" | sort)
|
|
DOCSET_PAGE_PATHS=$(shell echo '$(MKDOCS_PAGES)' | tr ' ' '\n' | grep -v '^index\.md$$' | $(SED) -E 's@/index\.md$$@/index.html@; s@\.md$$@/index.html@' | sort)
|
|
|
|
# list mkdocs pages missing from the docset index
|
|
.PHONY: list_missing_pages
|
|
list_missing_pages: docSet.dsidx
|
|
@comm -23 <(echo '$(DOCSET_PAGE_PATHS)' | tr ' ' '\n') <(echo '$(DOCSET_INDEX_PATHS)' | tr ' ' '\n')
|
|
|
|
# list paths in the docset index without a corresponding mkdocs page
|
|
.PHONY: list_removed_paths
|
|
list_removed_paths: docSet.dsidx
|
|
@comm -13 <(echo '$(DOCSET_PAGE_PATHS)' | tr ' ' '\n') <(echo '$(DOCSET_INDEX_PATHS)' | tr ' ' '\n')
|
|
|
|
.PHONY: clean
|
|
clean:
|
|
rm -f docSet.dsidx
|
|
rm -fr JSON_for_Modern_C++.docset JSON_for_Modern_C++.tgz
|