parchlinux-mobile/parchbootstrap
1
0
Fork 0
forked from parchlinux-mobile/kupferbootstrap
Code Issues Pull requests Activity

docs: add versions target to produce multi-version docs

Browse source 
ci-kbs-docs-build-full
This commit is contained in:
InsanePrawn 2022-12-15 07:07:53 +01:00
parent dc59378243
commit c7084895d6
8 changed files with 271 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

68
docs/Makefile
View file

@ -1,16 +1,70 @@
buildargs := -b dirhtml -aE source html
buildargs := -b dirhtml -aE source
.PHONY: cleanbuild clean
.PHONY: cleanbuild clean serve serve_versions versions versions_git versions_index .phony_explicit
.NOTINTERMEDIATE:
.PRECIOUS: versions/%/index.html checkouts/%/docs/html/index.html
# helper to make versions/%/index.html phony
.phony_explicit:
BRANCHES := main dev
TAGS := $(shell git tag)
FILTERTED_TAGS := $(foreach tag,$(TAGS),$(shell if [[ -n "$$(git log --max-count=1 --oneline "$(tag)" -- .)" ]]; then echo "$(tag)"; fi))
VERSIONS := $(BRANCHES) $(FILTERTED_TAGS)
cleanbuild:
@make clean
@make html
@$(MAKE) clean
@$(MAKE) html
clean:
rm -rf html source/cli .buildinfo .doctrees
rm -rf html source/cli .buildinfo .doctrees versions checkouts
html:
sphinx-build $(SPHINXARGS) $(buildargs)
sphinx-build $(SPHINXARGS) $(buildargs) html
serve: html
(cd html && python -m http.server 9999)
cd html && python -m http.server 9999
checkouts/%/docs/html/index.html:
@mkdir -p checkouts
@# use backslashed multi-line cmd because otherwise variables will be lost
@branch="$$(echo "$(@D)" | sed 's|^checkouts/||g;s|/docs/html$$||g')" && \
ref="$$branch" && \
if ! git log --max-count=1 --oneline "$$branch" >/dev/null 2>/dev/null ; then \
commit="$$(git ls-remote origin refs/{tags,heads}/"$$branch" | cut -f 1)" ; \
[[ -n "$$commit" ]] && echo "found commit $$commit for $$branch" >&2 && \
ref="$$commit" && git branch -f "$$branch" "$$ref" ; \
fi && \
[[ -n "$$(git log --max-count=1 --oneline "$$ref" -- .)" ]] || \
(echo "ERROR: branch '$$branch' seems to have no docs/ dir, checked ref '$$ref'" >&2 && exit 1) && \
checkout="checkouts/$$branch" && \
ver="$$(echo "$$branch" | sed 's|^v\([0-9]\)|\1|g')" && \
set -x && \
([[ -e "$$checkout/.git" ]] || git clone .. "$$checkout" ) && \
(! [[ -e "$$checkout/docs/source/conf.py" ]] || echo "version = '$$ver'" >> "$$checkout/docs/source/conf.py") && \
$(MAKE) -C "$$checkout/docs" SPHINXARGS="-D version=$$ver"
versions/%/index.html: checkouts/%/docs/html/index.html .phony_explicit
@mkdir -p versions
@# use backslashed multi-line cmd because otherwise variables will be lost
@branch="$$(basename "$(@D)")" && \
checkout="checkouts/$$branch" && \
echo "working on version '$$branch'" && \
set -x && \
cp -rf "$$checkout/docs/html/." "versions/$$branch/"
versions/versions.css: versjon/versions.css
@mkdir -p versions
cp versjon/versions.css versions/
versions_git:
@$(MAKE) $(patsubst %, versions/%/index.html, $(VERSIONS))
versions/index.html:
rm -rf versions/stable
@cd versions && set -x && versjon --stable-version main --user_templates ../versjon
versions: versions_git versions/versions.css
@$(MAKE) versions/index.html
serve_versions: versions
cd versions && python -m http.server 9888