# -*- coding: utf-8 -*-
"Pyccoon" is a side-to-side documentation generator.
Pyccoon produces a static HTML website that displays your comments alongside your code. Comments are formatted by Markdown, while the code is syntax highlighted by Pygments. MathJax helps with the notes.
This website is the result of running Pyccoon against its source.
Most probably you might want to use Pyccoon if you have a small-to-medium project (for example, a certain static documentation generator) with a lot of explaining to do or if you are a scientist that tries to sync the code with the context of research:
Pyccoon generates the documentation folder structured correspondingly to the code. To create
docs for the project in
src folder, run the following:
pyccoon -s src -d docs
Pyccoon is released on GitHub under the MIT license.
__author__ = 'Andrii Magalich' __email__ = 'email@example.com' __version__ = '0.1.7' from .pyccoon import Pyccoon