The CodeChat system for software documentation
Project description
Welcome to CodeChat, a programmer’s word processor. CodeChat encourages literate programming by transforming source files into web pages and by providing a powerful editor which synchronizes between the source code view and the web view of a document. CodeChat transforms plain-text source code into a beautiful and descriptive document, allowing you to record your ideas, helpful hyperlinks to on-line resources, include expressive images and diagrams, and much more.
Getting started
First, install Enki, which hosts the CodeChat system. Next, open some source code of a supported format [1]. In the Settings | Settings | CodeChat panel, click Enable then OK. Now, any properly-formatted comments will be interpreted as ReST. For example:
Source code |
|
---|---|
|
ReST works here.
|
Sphinx
“Sphinx is a tool that makes it easy to create intelligent and beautiful documentation” [2]. It provides additional features, including the ability to link together many documents (such as all the files in a program’s source code). Enki will soon support Sphinx.
ReST
“reStructuredText is an easy-to-read, what-you-see-is-what-you-get plaintext markup syntax” [3]. Helpful pages:
The excellent reStructuredText primer provided by the Sphinx project.
A longer Quick reStructuredText guide.
Contributing
This is a fairly basic implementation; much improvement is needed! Please use the issue tracker to report bugs or request features; even better, or contribute to the code at the CodeChat homepage!
Recent changes
0.0.10a1, release 17-Apr-2014:
Revamped packaging.
Updated docs.
Used .. instead of marker to indent comments, producing cleaner reST.
Split CodeToRest into CodeToRest, CodeToRestSphinx modules.
License
Copyright (C) 2012-2014 Bryan A. Jones.
This file is part of CodeChat.
CodeChat is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
CodeChat is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with CodeChat. If not, see <http://www.gnu.org/licenses/>.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for CodeChat-0.0.10a1-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8bfaa2aad437b78d31822fc07fe4fbdad0bb06e1b1e8577770ec2231ebe3f08d |
|
MD5 | 1b03c5807a2b5aa46ee5c4e7da2f4718 |
|
BLAKE2b-256 | d4366e218ec7eb87e7fd7b9186479419fd6e5caa1a97ea0ff2234375ad1cc725 |