跳转到主要内容

软件文档的CodeChat服务器

项目描述

CodeChat系统为各种文本编辑器和IDE提供强大的文献编程创作系统。具体来说,它提供了一个GUI,可以自动将源代码和/或标记文档渲染为HTML,并在旁边显示渲染过程产生的HTML文档。例如

https://raw.githubusercontent.com/bjones1/CodeChat_system/master/docs/CodeChat_screenshot_annotated.png

此截图显示了带有CodeChat扩展的Visual Studio Code编辑器。

在❶中,左侧面板显示包含Python源代码的Visual Studio Code文本编辑器。CodeChat将此源代码渲染到❷右侧面板,显示生成的HTML文档。最后,❸显示构建过程的输出。❷和❸之间的分隔器允许用户调整构建输出大小或完全隐藏它。在❸下方,状态栏显示构建状态和构建过程中产生的错误和警告的数量。

除了对Markdown和reStructuredText的原生支持外,CodeChat系统还通过用户提供的JSON配置文件支持几乎所有外部渲染器。例如,CodeChat可以

  • 调用Pandoc渲染各种标记格式;

  • 使用Sphinx构建项目文档;

  • 调用Runestone创建交互式教科书;

  • 使用 Doxygen 从源代码生成文档;

… 以及更多。请参阅 CodeChat 服务器文档 以开始使用。

项目详情


下载文件

下载适用于您平台的文件。如果您不确定选择哪个,请了解更多关于 安装包 的信息。

源分发

codechat_server-0.2.23.tar.gz (113.9 kB 查看哈希值)

上传时间 源代码

构建分发

CodeChat_Server-0.2.23-py3-none-any.whl (135.3 kB 查看哈希值)

上传时间 Python 3

由以下支持

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF 赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误日志 StatusPage StatusPage 状态页面