Greetings Pyloneers, The current Pylons templates set Pudge as a documentation formatter for Pylons projects. Pudge does basically two things:
1) it renders to HTML .txt file formated in restructured text; 2) it extracts docstrings and produce javadoc-style internal documentation. AsciiDoc is yet another project to solve aspect 1) of the documentation problem. I coded a distutils command to use AsciiDoc for documentation rendering in Python projects and I think some of your might be interested. Why AsciiDoc? AsciiDoc is a lightweight markup for DocBook. That means lots of semantic blocks like "example", "note", "warning" and the like. That also means that one can use many high quality Docbook stylesheets to produce HTML, PDF, and manpages with no extra work. Well, there is some work to setup the docbook toolchain but most GNU/Linux distributions have that part covered. Let's admit it, the AsciiDoc output is quite sexy. Learn more about it on it's website: http://www.methods.co.nz/asciidoc/index.html My current command only produces HTML but manpage and PDF is on my TODO list. So here it is: http://ygingras.net/files/asciidoc_cmd-0.3dev.tar.gz It only works with an experimental branch of AsciiDoc available here: http://ygingras.net/files/asciidoc-8.3.2dev.tar.gz I don't plan to cover aspect 2) at the moment. My idea is to use AsciiDoc to render user documentation and to use Pudge for developer doc. Would this be of interest for some of you? What features a documentation rendering system should have for you to adopt it? -- Yannick Gingras --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "pylons-discuss" group. To post to this group, send email to [email protected] To unsubscribe from this group, send email to [EMAIL PROTECTED] For more options, visit this group at http://groups.google.com/group/pylons-discuss?hl=en -~----------~----~----~----~------~----~------~--~---
