Dev8D Lightning Talk: Dexy – creating code documeentation

Ana Nelson (@ananelson) presenting http://dexy.it

Dexy is a documentation tool – runs through scripts and create documentation. Any code etc. produced in the documentation comes from the original code – so can easily refresh as code updates

Example shows how you can document multiple scripts in different languages in single set of documentation, and include outputs. Dexy runs tests so get test output. Dexy can also take screenshots as well while it runs the test.

Dexy can also output html and blog it directly to WordPress via API – Ana using code from ScraperWiki as an example. Dexy allows you to reference remote URL and it will pull into the document… can also pull source data from remote API/source.

Dexy is Python library, works well on Mac/Linux; Windows version there but not so polished; Command line tool

Leave a Reply

Your email address will not be published. Required fields are marked *

This site uses Akismet to reduce spam. Learn how your comment data is processed.