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 > "$$(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++||' {} + # 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%" "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