mirror of
https://github.com/johnkerl/miller.git
synced 2026-07-17 16:38:54 +00:00
e0ed7e469c
* Publish an epub of the docs on Read the Docs (#1835) Read the Docs' built-in formats support (the existing formats: all in .readthedocs.yaml) only produces epub/PDF for Sphinx projects, and is a silent no-op for MkDocs ones. Instead, per RTD's documented build-customization path, generate the epub ourselves in a post_build job and place it in $READTHEDOCS_OUTPUT/epub/, which RTD then publishes on the project Downloads page and in the docs flyout menu. The epub itself is built by the new docs/build-epub.sh: it takes the committed, generated Markdown pages in docs/src in mkdocs.yml nav order, strips the HTML-only quicklinks header from each page, and runs pandoc (installed on RTD via build.apt_packages). Locally, `make -C docs epub` does the same for anyone with pandoc installed; nothing here is part of `make dev` or any default build path. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * fix misrender --------- Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
12 lines
385 B
Makefile
12 lines
385 B
Makefile
# Turn src/*.md.in into respective src/*.md. Then, generate static HTML into ./site.
|
|
build:
|
|
make -C src genmds
|
|
mkdocs build
|
|
|
|
# Optional: build a single-file epub of the documentation for offline
|
|
# reading. Requires pandoc. Not part of the default build; Read the Docs runs
|
|
# this via .readthedocs.yaml (see docs/build-epub.sh for details).
|
|
epub:
|
|
./build-epub.sh
|
|
|
|
.PHONY: build epub
|