richguk / readme-this Goto Github PK

readme-this is an indispensable tool... but the Python project I'm preparing to upload has its README file written in reStructuredText so that it can be trivially included in the manual.

(Via Sphinx, reStructuredText is fast becoming the documentation format for Python. It'd probably already be there if the Sphinx devs put more effort into making the autodoc extension capable of being as automatic as competing tools like epydoc)

Have you considered just using github/markup to do the detection and rendering the way GitHub itself does? That'd also get you stuff like Wiki Creole, MediaWiki Syntax, ASCIIDoc, groff (manpages), and Perl's POD. (Were I not completely inexperienced with Ruby and behind schedule already, I'd try it myself and send you a pull request.)