The CodeChat system for software documentation

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for bjones from gravatar.com bjones

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: GNU General Public License v3 or later (GPLv3+) (UNKNOWN)
  • Author: Bryan A. Jones
Classifiers

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*.
//But not here -- a space must follow the comment.
/* Not here either. Only single-line comments work. */
a = 1; // Not here either. Comments must be on a
b = 2; // separate line, not following code.

ReST works here.

//But not here -- a space must follow the comment.
/* Not here either. Only single-line comments work. */
a = 1; // Not here either. Comments must be on a
b = 2; // separate line, not following code.

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:

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

Verified details

These details have been verified by PyPI
Maintainers
Avatar for bjones from gravatar.com bjones

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: GNU General Public License v3 or later (GPLv3+) (UNKNOWN)
  • Author: Bryan A. Jones
Classifiers

Release history Release notifications | RSS feed

1.9.4

1.9.3

1.9.2

1.9.1

1.9.0

1.8.9

1.8.8

1.8.7

1.8.6

1.8.5

1.8.4

1.8.3

1.8.2

1.8.1

1.8.0

1.7.3

1.7.2

1.7.1

1.7.0

1.6.1

1.6.0

1.5.9

1.5.8

1.5.7

1.5.6

1.5.5

1.5.4

1.5.3

1.5.2

1.5.1

1.5.0

1.4.1

1.4.0

1.3.1

1.3.0

1.2.1

1.2.0

1.1.1

1.1.0

1.1.0b3 pre-release

1.1.0b2 pre-release

1.1.0b1 pre-release

1.1.0b0 pre-release

1.0.1

1.0.0

0.0.19a1 pre-release

0.0.19a0 pre-release

0.0.18

0.0.17

0.0.16

0.0.15

0.0.14

0.0.13

0.0.12

0.0.12a1 pre-release

0.0.11

0.0.11a1 pre-release

0.0.10

0.0.10a3 pre-release

This version

0.0.10a2 pre-release

0.0.10a1 pre-release

0.0.9

0.0.8

0.0.7

0.0.5

0.0.4

0.0.3

0.0.2

0.0.1

0.0.0

Download files

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

Source Distribution

CodeChat-0.0.10a2.zip (46.0 kB view details)

Uploaded Source

Built Distribution

CodeChat-0.0.10a2-py2-none-any.whl (37.8 kB view details)

Uploaded Python 2

File details

Details for the file CodeChat-0.0.10a2.zip.

File metadata

  • Download URL: CodeChat-0.0.10a2.zip
  • Upload date:
  • Size: 46.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for CodeChat-0.0.10a2.zip
Algorithm Hash digest
SHA256 bc6a4b422e426bb697a67ea7f67f727f2e68be63461823a109cfe331664fd486
MD5 d8e89f155c63f1554d86f4ab5fc0fbe1
BLAKE2b-256 7040f7ada0bc25301e8532198928669824dd4d1c3d3cf7abbc8da0db27118f5e

See more details on using hashes here.

File details

Details for the file CodeChat-0.0.10a2-py2-none-any.whl.

File metadata

File hashes

Hashes for CodeChat-0.0.10a2-py2-none-any.whl
Algorithm Hash digest
SHA256 863582ccf62a4eea0a69a73a8331a20279d0b131385efb2dee3cf4912afc63bf
MD5 8bd76ab3309da4030317dba4cd4b2c9a
BLAKE2b-256 06662a197c104c011d85032b918c3085f7f24d69fecc347c3026135889d57ba7

See more details on using hashes here.

Supported by

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