MobileRead Forums - View Single Post

Valloric · 03-02-2010, 07:11 PM

It's time to make this happen. Sigil needs some docs.

I'd like the documentation to be written in reStructuredText, and then handed off to Sphinx which will then generate an epub and a nice PDF version with LaTeX (yes, PDF for technical documentation is preferable over epub).

But someone has to write the RST docs. I intend to write some/most/all of it depending on the number of volunteers. But I've said it before, and I'll say it again, the more time I spend writing docs is the less time I spend writing code.

The 0.2.0 interface is here to stay and no major redesigns are in the foreseeable future, so there's a relatively stable basis from which to work.

Anyone willing should post here, send me a PM, an email, whatever. Just get in contact.

03-02-2010, 07:11 PM	#13
Valloric Created Sigil, FlightCrew Posts: 1,982 Karma: 350515 Join Date: Feb 2008 Device: Kobo Clara HD	It's time to make this happen. Sigil needs some docs. I'd like the documentation to be written in reStructuredText, and then handed off to Sphinx which will then generate an epub and a nice PDF version with LaTeX (yes, PDF for technical documentation is preferable over epub). But someone has to write the RST docs. I intend to write some/most/all of it depending on the number of volunteers. But I've said it before, and I'll say it again, the more time I spend writing docs is the less time I spend writing code. The 0.2.0 interface is here to stay and no major redesigns are in the foreseeable future, so there's a relatively stable basis from which to work. Anyone willing should post here, send me a PM, an email, whatever. Just get in contact. Last edited by Valloric; 03-02-2010 at 07:16 PM.