miller icon indicating copy to clipboard operation
miller copied to clipboard

Documentation as epub resource, please

Open lobaluna opened this issue 5 months ago • 4 comments

Hi! I'm learning Miller to do multiple CSV data analysis. I'm really impressed for the ease of use! Thank you very much! Congratulations!

Any chance that you open the possibilty to download the documentation as ePUb, so I can read it in my Kobo while in public transport? It would be a much appreciated gesture.

lobaluna avatar Jul 16 '25 02:07 lobaluna

Hi @lobaluna, the great Miller website is built using MkDocs and written in Markdown.

There is a plugin available to export it as a PDF. The result isn't perfect, but it's a good starting point for creating an EPUB file.

I did a test and here's the result: https://github.com/user-attachments/files/21248110/Miller.Dev.Documentation.-.John.Kerl.zip

I haven't found a better solution so far.

I also created a how-to guide for you: https://chatgpt.com/canvas/shared/68773d44a56081919fa8299a849718d3

aborruso avatar Jul 16 '25 05:07 aborruso

Hi, @aborruso, thanks for helping me! You are really kind. Thanks!!!

Let me confess that my first attempt was to download all pages, one by one, then using EpubMerge plugin for calibre, I created the ePUB. It was not perfect, but fluid (for my Kobo, specially).

That's why PDFs are not the best solution for me. They do not convert well to epUB either :(

Nevertheless, I'm using the PDF you created, so far. Thanks again!

However, I read somewhere in the Internet that ReadTheDocs gives the facility for admins to create ePUBs of documentation. That's why I respectfully ask @johnkerl to help us. Maybe he didin't notice that feature as an importante one.

lobaluna avatar Jul 16 '25 21:07 lobaluna

Thanks @lobaluna ! I'll look into epub.

I have good success with https://miller.readthedocs.io/en/latest/ on mobile -- the formatting is very nice -- however, this does require a data connection which may not be available on all forms of public transport.

johnkerl avatar Jul 16 '25 21:07 johnkerl

Exactly! My case is public transport. Thank you very much.

lobaluna avatar Jul 17 '25 05:07 lobaluna