Commit graph

12 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
950337fde1
Simplify release & dev build processes (#735) 2021-11-07 23:41:15 -05: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
John Kerl
5c28982419
Make docs more mobile-friendly (#572) 2021-06-14 22:25:29 -04:00
John Kerl
ab1731f7e7 sphinx-neaten 2021-05-31 01:51:01 -04:00
John Kerl
c7556cda26 Attempt to unbreak readthedocs build 2021-05-31 01:41:01 -04:00
John Kerl
5da252172b Attempt to unbreak readthedocs build 2021-05-31 01:31:04 -04:00
John Kerl
b6f3be69a1 Makefile build-order comments 2021-03-31 17:40:51 -04:00
John Kerl
99b4cb6ba8 Update manpage-build procedure 2021-03-23 22:58:31 -04:00
John Kerl
0b63007c24 Restore mlr.1 manpage in dist-file 2021-03-22 23:32:31 -04:00
John Kerl
7d8d35dcac mkman 2020-09-29 23:01:33 -04:00
John Kerl
4f49f6a037 more linkfix 2020-09-29 19:49:01 -04:00