Sphinx创建智能且美观的文档
Sphinx 是由 Georg Brandl 编写的工具,可轻松为 Python 项目(或由多个 reStructuredText 源组成的其他文档)创建智能且美观的文档。它最初是为新的 Python 文档创建的,具有用于Python项目文档的出色功能,但同时也支持C / C ++,并且计划了更多的语言。
Sphinx使用reStructuredText作为标记语言,它的许多优势来自reStructuredText及其解析和翻译套件Docutils的强大功能和直接性。
其功能包括:
- 输出格式:HTML(包括派生格式,例如HTML帮助,Epub和Qt帮助),纯文本,手册页和LaTeX或使用rst2pdf的直接PDF输出
- 广泛的交叉引用:功能,类,词汇术语和类似信息的语义标记和自动链接
- 层次结构:轻松定义文档树,并自动链接到兄弟姐妹,父母和孩子
- 自动索引:常规索引以及模块索引
- 代码处理:使用Pygments荧光笔自动突出显示
- 使用Jinja 2模板引擎灵活的HTML输出
- 提供各种扩展名,例如,用于自动测试代码片段和包含适当格式的文档字符串
- Setuptools 集成
评论
Sphinx 文档工具
Sphinx简单来说,是一个文档生成工具,用于把reStructuredText格式的源文件生成诸如HTML,PDF,LaTex一类的格式。编辑者无须亲自处理文本的格式,程序会自动根据源文件里的设置产
Sphinx 文档工具
0
Strapdown.jsMarkdown 文档创建
Strapdown.js 可以让你非常简单的创建优雅的 Markdown 文档,无需服务器端编译支持
Strapdown.jsMarkdown 文档创建
0
Strapdown.jsMarkdown 文档创建
Strapdown.js可以让你非常简单的创建优雅的Markdown文档,无需服务器端编译支持,只需要简单的复制HTML代码并修改标题和Markdown文本即可。示例代码:<!DOCTYPEht
Strapdown.jsMarkdown 文档创建
0
Furo可定制的 Sphinx 文档主题
Furo是一个干净的可定制的Sphinx文档主题。ElevatorpitchIntentionallyminimal--最重要的是内容,而不是其周围的脚手架。响应性---完美适应可用的屏幕空间,在各种
Furo可定制的 Sphinx 文档主题
0
WAXXML 文档创建工具
WAX是一个用于创建大型XML文档的高效工具。与其它XML操作类库(如JDOM)相比,它占用的内存比较少。创建XML所需要的代码也比较少。只关注创建功能,而没有读取/解析功能。整个类库只有12K左右。
WAXXML 文档创建工具
0