docs icon indicating copy to clipboard operation
docs copied to clipboard

Also provide the EPUB and PDF versions of the documentation

Open lenucksi opened this issue 9 years ago • 3 comments

  • Syncthing has quite some documentation.
  • The used Sphinx documentation generator can generate EPUB and PDF also and offer it for download, which I would like to use to read the documentation more comfortably.

lenucksi avatar Oct 07 '16 20:10 lenucksi

I am sure you can run the generator yourself for your needs?

AudriusButkevicius avatar Oct 07 '16 20:10 AudriusButkevicius

The FAQ and getting started guides are pdf:d and included in the release package, the latest output being here: https://docs.syncthing.net/pdf/

We could add more pages to the pdf-ification and output them. But I don't necessarily think adding pdfs for every section is useful (they could be combined somehow?), and they should then be linked somehow from the html pages themselves.

calmh avatar Oct 07 '16 22:10 calmh

@AudriusButkevicius I actually ended up running the generator myself from master, yes. However, it would have been nice, if something like the requests-toolbelt provides would have been there: https://toolbelt.readthedocs.io/en/latest/ (Click "Read the docs" on the bottom left side)

lenucksi avatar Oct 09 '16 10:10 lenucksi