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+) (GPLv3+)
  • Author: Bryan A. Jones
  • Tags literate, programming
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.

Installation

First, install pip if you don’t yet have it. Then, from a command prompt, run pip install -U CodeChat. The -U flag upgrades CodeChat to the latest version if it’s already installed.

Next install Enki, which hosts the CodeChat system.

Use

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

CodeChat results

 
// 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). To use Sphinx with Enki:

  1. Go to Settings | Settings | CodeChat and enable Sphinx and CodeChat.

  2. Choose a project directory, which contains source code to document.

  3. Click OK. Then, open a source file in the project directory you select.

  4. Open the Preview pane, where the source code will be displayed.

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

  • Development version:

    • Update setup.py based on modern usage.

    • Update docs.

    • Remove unused PyQt dependencies.

    • Modernize documentation style in LanguageSpecificOptions.py.

  • 0.0.17, 17-Nov-2014:

    • Support Sphinx versions before 1.2.

    • Move non-CodeChat templates to Enki.

  • 0.0.16 - 0.0.13, 11-Nov-2014:

    • Improved Sphinx template: doesn’t replace default.css.

    • Updated CSS to work better with docutils.

  • 0.0.12, released 1-Sep-2014:

    • Fixes so that CodeChat’s Sphinx extension now works.

    • File encoding can now be specified.

    • Installaiton instructions added and docs reworked.

  • 0.0.11, released 1-May-2014:

    • Fixed Unicode errors.

    • Removed incorrect extra spacing between code and comments.

    • Fixed unit tests and added a few more.

    • Removed unused CodeLink directive.

  • 0.0.10, released 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+) (GPLv3+)
  • Author: Bryan A. Jones
  • Tags literate, programming
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

This version

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

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.19a1.zip (52.2 kB view details)

Uploaded Source

Built Distribution

CodeChat-0.0.19a1-py2-none-any.whl (69.7 kB view details)

Uploaded Python 2

File details

Details for the file CodeChat-0.0.19a1.zip.

File metadata

  • Download URL: CodeChat-0.0.19a1.zip
  • Upload date:
  • Size: 52.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for CodeChat-0.0.19a1.zip
Algorithm Hash digest
SHA256 40b895c8a13c8f9f72bb196c75dee401ad0b9f11f64c51a96d6cec4f232eeb19
MD5 fed08cd72d6f1f6d683bfc3696eff6de
BLAKE2b-256 6f78be11ba2deac45e23a19ff3caa7ae3e7cb2e40ae1f9ce392c47cc9b1fc71c

See more details on using hashes here.

File details

Details for the file CodeChat-0.0.19a1-py2-none-any.whl.

File metadata

File hashes

Hashes for CodeChat-0.0.19a1-py2-none-any.whl
Algorithm Hash digest
SHA256 c3ec97a445c9f7c2c1387f6c7fdeb107d07411b626353cd0416d62011b11163a
MD5 1b78ba0f026c11254457ced4ba4c8e5a
BLAKE2b-256 cfd31e15e1d1476aacf12e579d5d18e5157eeebc3d26c4ca776f26239e4f002b

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