search

kizniche / Mycodo

An environmental monitoring and regulation system
http://kylegabriel.com/projects/
GNU General Public License v3.0
2.89k stars 488 forks source link

Update MyCodo documentation PDF file? (Currently 8.2.3) #1301

Closed victorhooi closed 1 year ago

victorhooi commented 1 year ago

Is there any possibility of having the MyCodo documentation available as a PDF file?

There's an old version (8.2.3) available here - which whilst outdated, is still pretty useful:

https://www.researchgate.net/profile/Kyle-Gabriel/publication/328228021_Mycodo_Environmental_Regulation_System/data/5e30962892851c7f7f08b97f/mycodo-manual-823.pdf

Is there any chance of updating this to the current version please? (Or possibly making it some kind of automated/CI style build).

kizniche commented 1 year ago

I don't plan to generate PDF manuals again. The online documentation is sufficient.

victorhooi commented 1 year ago

Oh bugger =(.

Well, it was more that the PDF file is pretty helpful for ebook readers (e.g. Remarkable tablets, Kindle Scribe etc.)

Either PDF or ePUB would be fine for eink devices.

Was it quite difficult to have the docs output to a PDF version? Is there anything we could do to help?

Or do you think it'd be possible to paste any info on how you did it before, so the community could take a look, mayhaps, or people could try to generate it themselves?

kizniche commented 1 year ago

I can't justify taking up several MB of space every new manual. It is a burden for github and those cloning the repo if it rapidly grows to hundreds of MB for no good reason (versioning a binary file).

You're welcome to look at the mkdocs config file and its history (for pdf support), if you want to generate it yourself.

kizniche commented 1 year ago

FYI the mkdocs pdf plugin doesn't work with the multilingual plugin. So you can either have a manual in 10+ languages or a manual in 1 language.