docs: make an index.html page for the PDF docs

SebKuzminsky · SebKuzminsky · commit 14477fe14ce5 · 2022-04-24T10:47:14.000-06:00
diff --git a/docs/.gitignore b/docs/.gitignore
@@ -0,0 +1,2 @@
+# generated when building pdf docs
+index.html
diff --git a/docs/src/Submakefile b/docs/src/Submakefile
@@ -434,7 +434,10 @@ ifeq ($(BUILD_DOCS_HTML),yes)
 docs: htmldocs
 install-doc: install-doc-html
 endif
+
 pdfdocs: $(PDF_TARGETS)
+	../scripts/make-docs-pdf-index
+
 htmldocs: .htmldoc-stamp checkref
 
 .htmldoc-stamp: copy_asciidoc_files $(HTML_TARGETS) .html-images-stamp
diff --git a/scripts/make-docs-pdf-index b/scripts/make-docs-pdf-index
@@ -0,0 +1,27 @@
+#!/bin/bash
+#
+# Make a pretty(?) index page of the PDF docs.
+#
+
+set -e
+
+# Assume we're running in src/, we can't call `git rev-parse
+# --show-toplevel` because when building from dsc we don't have a
+# git repo.
+TOPLEVEL=${PWD}/..
+cd ${TOPLEVEL}/docs
+
+TITLE="LinuxCNC PDF docs ($(cat ${TOPLEVEL}/VERSION))"
+
+rm -f index.html
+
+echo "<html>" >> index.html
+echo "<head><title>${TITLE}</title></head>" >> index.html
+echo "<body><h1>${TITLE}</h1><p>" >> index.html
+
+for F in $(ls -1 *.pdf | sort); do
+    echo "    <a href=\"${F}\">$F</a><br>" >> index.html
+done
+
+echo "</body>" >> index.html
+echo "</html>" >> index.html

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+# generated when building pdf docs`
	`2`	`+index.html`