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.2.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 72661b130b439a2c798abd55c379adcba2c2547a151e8669a2b26b571a35c067 |
|
MD5 | ec21b6832580271d2c62caa3274ae8d6 |
|
BLAKE2b-256 | 83478ad1acffda5f13074b153f20cedd80e352e68443b328950b112c2bf2b53b |