.. Copyright (C) 2012-2022 Bryan A. Jones.
This file is part of the CodeChat System.
The CodeChat System 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.
The CodeChat System 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 </docs/LICENSE>` along with the CodeChat System. If not, see http://www.gnu.org/licenses/.
The CodeChat System
===================
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:
.. figure:: https://raw.githubusercontent.com/bjones1/CodeChat_system/master/docs/CodeChat_screenshot_annotated.png
This screenshot shows the Visual Studio Code editor with the CodeChat extension.
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 <https://pandoc.org/>`_ to render a wide variety of markup formats;
- use `Sphinx <https://www.sphinx-doc.org/>`_ to build project documentation;
- call `Runestone <https://runestone.academy/>`_ to create interactive textbooks;
- employ `Doxygen <https://www.doxygen.nl/>`_ to generate documentation from source code;
... and many more. See the `CodeChat Server documentation <https://codechat-system.readthedocs.io/en/latest/CodeChat_Server/contents.html>`_ to get started.
Raw data
{
"_id": null,
"home_page": "http://codechat.readthedocs.io/en/latest/",
"name": "CodeChat-Server",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "literate programming",
"author": "Bryan A. Jones",
"author_email": "bjones@ece.msstate.edu",
"download_url": "https://files.pythonhosted.org/packages/7d/a7/178a02d47f95ad8517cab3f560f6d5270d08018b221d8d4e32842cee425b/CodeChat_Server-0.2.21.tar.gz",
"platform": null,
"description": ".. Copyright (C) 2012-2022 Bryan A. Jones.\r\n\r\n This file is part of the CodeChat System.\r\n\r\n The CodeChat System 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.\r\n\r\n The CodeChat System 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.\r\n\r\n You should have received a `copy of the GNU General Public License </docs/LICENSE>` along with the CodeChat System. If not, see http://www.gnu.org/licenses/.\r\n\r\nThe CodeChat System\r\n===================\r\nThe 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:\r\n\r\n.. figure:: https://raw.githubusercontent.com/bjones1/CodeChat_system/master/docs/CodeChat_screenshot_annotated.png\r\n\r\n This screenshot shows the Visual Studio Code editor with the CodeChat extension.\r\n\r\nIn \u2776, the left panel shows a the Visual Studio Code text editor with Python source code. CodeChat renders this source code to \u2777, the right panel, which shows the resulting HTML document. Finally, \u2778 displays output from the build process. A splitter between \u2777 and \u2778 allows the user to adjust the build output size or hide it entirely. Below \u2778, a status bar displays the build status and a count of errors and warnings produced by the build.\r\n\r\nIn 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:\r\n\r\n- invoke `Pandoc <https://pandoc.org/>`_ to render a wide variety of markup formats;\r\n- use `Sphinx <https://www.sphinx-doc.org/>`_ to build project documentation;\r\n- call `Runestone <https://runestone.academy/>`_ to create interactive textbooks;\r\n- employ `Doxygen <https://www.doxygen.nl/>`_ to generate documentation from source code;\r\n\r\n... and many more. See the `CodeChat Server documentation <https://codechat-system.readthedocs.io/en/latest/CodeChat_Server/contents.html>`_ to get started.\r\n",
"bugtrack_url": null,
"license": "GPLv3+",
"summary": "The CodeChat Server for software documentation",
"version": "0.2.21",
"project_urls": {
"Homepage": "http://codechat.readthedocs.io/en/latest/"
},
"split_keywords": [
"literate",
"programming"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "13e8b7f2506eece32eb36969129369b859b8c5c5c73cd6411c24f5d031bb8b89",
"md5": "926ba827824418e5b7fa772fe8813b89",
"sha256": "dff5962a4b286a71e1064bc6d2231f23b40624153eecf0bf1edab2de303fe6be"
},
"downloads": -1,
"filename": "CodeChat_Server-0.2.21-py3-none-any.whl",
"has_sig": false,
"md5_digest": "926ba827824418e5b7fa772fe8813b89",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 134934,
"upload_time": "2023-11-08T22:10:12",
"upload_time_iso_8601": "2023-11-08T22:10:12.808317Z",
"url": "https://files.pythonhosted.org/packages/13/e8/b7f2506eece32eb36969129369b859b8c5c5c73cd6411c24f5d031bb8b89/CodeChat_Server-0.2.21-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7da7178a02d47f95ad8517cab3f560f6d5270d08018b221d8d4e32842cee425b",
"md5": "b592b95fc5ebe53267463eb9b5d9f6c9",
"sha256": "e37fd7b442f46e090fbc98afb385303115e043b5ff9b6fc894a35b434dcd6bcc"
},
"downloads": -1,
"filename": "CodeChat_Server-0.2.21.tar.gz",
"has_sig": false,
"md5_digest": "b592b95fc5ebe53267463eb9b5d9f6c9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 113573,
"upload_time": "2023-11-08T22:10:14",
"upload_time_iso_8601": "2023-11-08T22:10:14.647715Z",
"url": "https://files.pythonhosted.org/packages/7d/a7/178a02d47f95ad8517cab3f560f6d5270d08018b221d8d4e32842cee425b/CodeChat_Server-0.2.21.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-08 22:10:14",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "codechat-server"
}
JSON