Quote:
Originally Posted by eureka
Another one suggestion: write user manual with the help of Sphinx and maintain it in source tree. There is a free service Read The Docs for hosting Sphinx-based documentation. It includes deep integration with GitHub and automatic update of documentation on every commit (with the help of GitHub webhook). It also compiles documentation into PDF and EPUB formats.
There are downsides, of course. It will require Python for local testing of documentation, learning of Sphinx for documentation setup and learning of reStructuredText for documentation writing (however, reStructuredText is close to Markdown).
I understand that user manual writing isn't a priority for now and GitHub wiki is pretty fine suited for current needs. Just wanted to describe one of other possible variants. |
Yeah, I am also thinking of the better way to maintain user document. It will be great if we can generate PDF/EPUB and ship it within release package. I am pretty sure that there are many undocumented features in KOReader and KPV that people haven't found out yet ;p
The good side of documentation framework like Sphinx is it's in the source tree so we can take complete control over it, automate stuffs, etc. It's generaly more develper friendly.
But the down side is also it's in source tree, so other users cannot help improve it without knowing Git and Github.
I am thinking of generating PDF/EPUB from the wiki, since it's stored as markdown and can be checked out via Git. What do you think about this approach? Any better ideas?