The CodeChat server for software documentation
Project description
The CodeChat system provides a powerful literate programming authoring system to a variety of text editors and IDEs. Specifically, it provides a GUI to automatically render source code and/or markup documents to HTML, displaying the HTML document produced by the rendering process next to the source. For example:
In ❶, the left panel shows a the Visual Studio Code text editor with Python source code. CodeChat renders this source code to ❷, the right panel, which shows the resulting HTML document. Finally, ❸ displays output from the build process. A splitter between ❷ and ❸ allows the user to adjust the build output size or hide it entirely. Below ❸, a status bar displays the build status and a count of errors and warnings produced by the build.
In addition to native support for Markdown and reStructuredText, the CodeChat system supports almost any external renderer via user-provided JSON configuration files. For example, CodeChat can:
invoke Pandoc to render a wide variety of markup formats;
use Sphinx to build project documentation;
call Runestone to create interactive textbooks;
employ Doxygen to generate documentation from source code;
… and many more. See the CodeChat server documentation to get started.
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_Server-0.0.13-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3b27955bea2a370082298d047ca1b294bf56c086aea4c2f3f02f94fbb2bfc201 |
|
MD5 | 287585588ba059d662b3ddbb0ef311e6 |
|
BLAKE2b-256 | 31dcb3f3380a3074417e496fd2f7eda211836bc3cffb39c1858fc9399be38d40 |