Create ebook from docs
This is asked by a customer, but it would be a good addition overall. We'd like to have a pdf version of docs, ideally epub and mobi files.
Proposal
We have a few options.
mdbook
Use mdBook's ability to convert to ebooks https://rust-lang.github.io/mdBook/.
- We need a
SUMMARY.md
file in the root dir of our docs which relatively links to all documents. Since we pull from different projects we need this file inside each project (CE, EE, Omnibus, Runner). - We also need a
book.toml
file that will hold the book info, like title, description, etc. - We should remove all documents that direct to new locations with sth like:
grep -R "^This document was moved" . | cut -d':' -f1 | xargs rm
- Relates to #48 (closed) since it involves creating correct index files. Once we have them we could hack our way to automatically create
SUMMARY.md
from those index files.
Nanoc
Nanoc also supports creating PDFs (with some tinkering) https://nanoc.ws/doc/guides/creating-pdfs/. If we successfully set this up, we can have a manual job to create a pdf at will.