Commit graph

6 commits

Author SHA1 Message Date
John Kerl
e0ed7e469c
Publish an epub of the docs on Read the Docs (#1835) (#2166)
* 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>
2026-07-07 14:55:36 -04:00
John Kerl
2ac27714d8 Miller 6.5.0 2022-11-27 12:48:33 -05:00
John Kerl
36f3c3cb0f Clarify locations of performance info 2022-11-26 18:32:16 -05:00
John Kerl
529f559422 Doc updates for #960 2022-02-22 00:10:49 -05:00
John Kerl
3105beb742 Fix some doc links 2021-11-05 11:14:14 -04:00
John Kerl
7578b789f6
Remove Miller-5 source/doc/manpage directories, along with C-build files (#731) 2021-11-04 00:45:44 -04:00
Renamed from docs6/src/reference-main-arrays.md (Browse further)