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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyccoon-0.1.5.tar.gz (41.7 kB view details)

Uploaded Source

File details

Details for the file pyccoon-0.1.5.tar.gz.

File metadata

  • Download URL: pyccoon-0.1.5.tar.gz
  • Upload date:
  • Size: 41.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for pyccoon-0.1.5.tar.gz
Algorithm Hash digest
SHA256 21232b379092bad3b9e908dbd5835fbe0d96306dcebbd6c9327b1bb10a3ba3b4
MD5 7e6acdd85a3cec5705a7fed6a7cb5b2a
BLAKE2b-256 42fcedd6b5b5aaaab02c515b36fea9dd994a1b81b8e7109e67b2274c096d3663

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page