Convert to using sphinx-doc #44

Open
infinity0 opened this Issue Jan 20, 2013 · 3 comments

Comments

Projects
None yet
2 participants
@infinity0
Member

infinity0 commented Jan 20, 2013

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

This comment has been minimized.

Show comment Hide comment
@infinity0

infinity0 Jan 20, 2013

Member

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.

Member

infinity0 commented Jan 20, 2013

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

This comment has been minimized.

Show comment Hide comment
@samthetechie

samthetechie May 22, 2013

Owner

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

Owner

samthetechie commented May 22, 2013

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

@infinity0

This comment has been minimized.

Show comment Hide comment
@infinity0

infinity0 May 22, 2013

Member

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.

Member

infinity0 commented May 22, 2013

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment