cryptoparty / handbook

The CryptoParty Handbook
https://www.cryptoparty.in/learn/handbook
526 stars 136 forks source link

Convert to using sphinx-doc #44

Open infinity0 opened 11 years ago

infinity0 commented 11 years ago

http://sphinx-doc.org/ is ideal for this sort of thing - it takes reStructuredText input and converts it into many different formats, including multi-page HTML or single-document PDF.

rst is better than markdown for large scale documentation - the source code just as human-readable, comparatively easy to write, but feature-complete in that you can customise it arbitrarily with your own templates etc.

infinity0 commented 11 years ago

It is possible to do much of the conversion (md->rst) automatically using http://johnmacfarlane.net/pandoc/ but some manual review will still be required for hyperlinks and proper content structure.

samthetechie commented 11 years ago

Are you happy if I close this ticket or would you like to look into this further?

infinity0 commented 11 years ago

I don't have time to look into it, so close it if you have something against open tickets that don't have anyone to work on it. But otherwise, please leave it open.