A plugin based documentation generator based off the Docco and Pycco projects. Check out the self-generated documentation
Docco and its relatives are quite wonderful; however, its monolithic nature makes extension and customization rather painful. Pycclone aims to be easily extensible and styleable by implementing an extremely simple plugin architecture.
- Massively extendable plugin architecture while keeping the template classes clean and simple.
- Simple json configuration
- Separates comments intened as documentation and those intended inline with code
- Documentation comments begin the line
- Inline comments occer after some code on a line
- If a multiline comment is started after code, the whole comment block is inlined with the code
Some documentation generators let you write an index.md file and will parse it to a special non-code index page.
Pycclone will never support this, it is strictly for generating a static page for each code file.