Skip to main content

Side-to-side documentation generator, a descendant of Pycco and Docco.

Project description

| |Pyccoon|

| |PyPi package|
| |Build Status|
| |Downloads|

Side-to-side documentation generator. Fork of the
`Pycco <http://fitzgen.github.io/pycco/>`__, grandfork of the
`Docco <http://jashkenas.github.com/docco/>`__. And an object-oriented
one.

"**Pyccoon**" is a side-to-side documentation generator.

It descended from `Pycco <https://github.com/fitzgen/pycco>`__ — a Python port of
`Docco <http://jashkenas.github.com/docco/>`__:
the original quick-and-dirty, hundred-line-long, literate-programming-style
documentation generator.

Pyccoon produces a static HTML website that displays your comments
alongside your code. Comments are formatted by
`Markdown <http://daringfireball.net/projects/markdown/syntax>`__,
while the code is syntax highlighted by `Pygments <http://pygments.org/>`__.
`MathJax <https://www.mathjax.org/>`__ helps with the TeX notes.

`See how it works <http://ckald.github.io/pyccoon/>`__
or read more on `Github <https://github.com/ckald/pyccoon>`__.



History
-------

0.1.0 (2014-09-07)
---------------------

* First release on PyPI.

Project details


Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page