Skip to main content

Literate-programming-style documentation generator.

Project description

Dycco is a(nother) Python port of Docco, the original quick-and-dirty, hundred-line-long, literate-programming-style documentation generator. For an example and more information, see its self-generated docs.

This port of Docco has fewer features than the pimary Python port, Pycco. For instance, Dycco can generate documentation for Python files and nothing else. It was written mostly as a reason to play with Python’s AST.

You should probably use Pycco instead.

Installation

Use pip to install:

pip install dycco

Usage

Command Line Usage

Just pass dycco a list of files and it will generate documentation for each of them. By default, the generated documentation is put in a docs/ subdirectory:

$ dycco my_python_file.py

Dycco can generate docs for multiple files at once:

$ dycco my_package/*.py

And you can control the output location:

$ dycco --output-dir=/path/to/docs my_package/*.py

All command line options are given below:

$ dycco --help

Outputs:

usage: dycco [-h] [-o OUTPUT_DIR] source_file [source_file ...]

Literate-style documentation generator.

positional arguments:
  source_file           Source files to document

optional arguments:
  -h, --help            show this help message and exit
  -o OUTPUT_DIR, --output-dir OUTPUT_DIR
                        Output directory (will be created if necessary)

Library Usage

Dycco can also be used as a plain old Python library:

>>> import dycco
>>> dycco.document('my_python_file.py', 'my_output_dir')

Credits

Dycco is just a simple re-implementation of Docco, with some inspiration and template code from its primary Python port Pycco.

Project details


Release history Release notifications

This version
History Node

1.0.1

History Node

1.0.0

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
dycco-1.0.1.tar.gz (10.7 kB) Copy SHA256 hash SHA256 Source None May 3, 2014

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page