apenwarr-redo/docs/mkdocs.do

redo-ifchange doc.list
xargs redo-ifchange ../mkdocs.yml <doc.list

# Most people don't have mkdocs installed, or are using an obsolete one,
# so let's handle those cases gracefully.
ver=$(mkdocs --version 2>/dev/null | cut -d' ' -f3)
check='
import sys
ok = sys.argv[1].split(".") >= ["1", "0", "4"]
exit(not ok)
'

if ! type mkdocs >/dev/null 2>/dev/null; then
	echo "Warning: mkdocs is missing; can't generate website." >&2
	redo-ifcreate /usr/bin/mkdocs
elif ! python -c "$check" "$ver"; then
	echo "Warning: mkdocs is too old ($ver); need at least 1.0.4." >&2
	mkd=$(which mkdocs 2>/dev/null || :)
	[ -x "$mkd" ] && redo-ifchange "$mkd"
else
	(cd .. && mkdocs build --strict --clean)
fi
Generate a basic documentation website with the mkdocs toolkit. No content yet other than man pages. To make the man pages render nicely in mkdocs, I removed the static %-headers and put the code for them into default.md.tmp.do instead. That way, the raw input redo-*.md files will look right in mkdocs. 2018-11-15 23:59:22 -05:00			`redo-ifchange doc.list`
Move mkdocs.yml into root directory, so readthedocs.org will work. 2018-11-16 01:14:15 -05:00			`xargs redo-ifchange ../mkdocs.yml <doc.list`
Generate a basic documentation website with the mkdocs toolkit. No content yet other than man pages. To make the man pages render nicely in mkdocs, I removed the static %-headers and put the code for them into default.md.tmp.do instead. That way, the raw input redo-*.md files will look right in mkdocs. 2018-11-15 23:59:22 -05:00
mkdocs: enforce sufficiently new version, and use mkdocs-exclude. We want to use the mkdocs-exclude plugin, which lets us exclude particular files from the output directory. But plugins aren't available in the debian-stable version of mkdocs, so ensure that we're running a sufficiently new version. If we aren't, gracefully just skip building the documentation. 2019-01-08 01:32:16 -05:00			`# Most people don't have mkdocs installed, or are using an obsolete one,`
			`# so let's handle those cases gracefully.`
			`ver=$(mkdocs --version 2>/dev/null \| cut -d' ' -f3)`
			`check='`
			`import sys`
			`ok = sys.argv[1].split(".") >= ["1", "0", "4"]`
			`exit(not ok)`
			`'`

			`if ! type mkdocs >/dev/null 2>/dev/null; then`
Generate a basic documentation website with the mkdocs toolkit. No content yet other than man pages. To make the man pages render nicely in mkdocs, I removed the static %-headers and put the code for them into default.md.tmp.do instead. That way, the raw input redo-*.md files will look right in mkdocs. 2018-11-15 23:59:22 -05:00			`echo "Warning: mkdocs is missing; can't generate website." >&2`
			`redo-ifcreate /usr/bin/mkdocs`
mkdocs: enforce sufficiently new version, and use mkdocs-exclude. We want to use the mkdocs-exclude plugin, which lets us exclude particular files from the output directory. But plugins aren't available in the debian-stable version of mkdocs, so ensure that we're running a sufficiently new version. If we aren't, gracefully just skip building the documentation. 2019-01-08 01:32:16 -05:00			`elif ! python -c "$check" "$ver"; then`
			`echo "Warning: mkdocs is too old ($ver); need at least 1.0.4." >&2`
			`mkd=$(which mkdocs 2>/dev/null \|\| :)`
			`[ -x "$mkd" ] && redo-ifchange "$mkd"`
			`else`
			`(cd .. && mkdocs build --strict --clean)`
Generate a basic documentation website with the mkdocs toolkit. No content yet other than man pages. To make the man pages render nicely in mkdocs, I removed the static %-headers and put the code for them into default.md.tmp.do instead. That way, the raw input redo-*.md files will look right in mkdocs. 2018-11-15 23:59:22 -05:00			`fi`