Reference manual

The manual presents links whose targets give a full explanation of each concept.

Syntax

See the style guide.

Docutils

CodeChat adds the following role and directives to Docutils:

JavaScript

  • CodeChat documents include JavaScript to correctly style the resulting HTML. This JavaScript is invoked when the document is ready. To style dynamically-added content, invoke CodeChat_doStyle(element) to style element and all its children.

Sphinx

CodeChat provides the CodeToRestSphinx.py - a Sphinx extension to translate source code to reST extension. This extension provides the following configuration options:

It also provides the following utilities:

API

CodeChat provides the following API: