Hacker Newsnew | past | comments | ask | show | jobs | submitlogin

Does anyone know a good format/toolset for writing docs, wherein I can embed tests of claims made in the documentation, so that the team (maybe just me, maybe me and others, maybe just others later) is forced to notice when the code and docs drift apart?


Sphinx (http://sphinx-doc.org/), my tool of choice for writing documentation, includes an extension that does this: http://sphinx-doc.org/ext/doctest.html.




Guidelines | FAQ | Lists | API | Security | Legal | Apply to YC | Contact

Search: