Sphinx文档管理与写作工具

Hint

构建时间 Aug 13, 2024

本手册为 Sphinx 和 reStructuredText 简明教程, 利用这些工具,你可以很容易的做出漂亮的文档。 Sphinx是用于创建文档的流行应用程序,类似于JavaDoc或Jekyll。 Sphinx渲染导出格式丰富, 如HTML、PDF, 借助一些工具还可以导出Latex、epub等文件。

教程力求简明,包含但不限于如下内容:

  • Sphinx使用介绍

  • reStructuredText语法说明

  • 与Sphinx相关的一些工具

该手册采用reStructuredText标记语言撰写,使用Sphinx进行发布。

参考项目

索引

Index

目录