这几天准备编排部分翻译的书籍囷文档找了好些工具，最终定格在 Sphinx 上并基于 提供的 SaaS 服务进行分发和分享。本篇博客是对整个过程的一次记录和总结

是一个基于 python生成圖文文档 的文档生成项目。最早只是用来生成 的项目文档使用 reStructuredText 格式。但随着项目的逐渐完善很多非 python生成图文文档 的项目也采用 Sphinx 作为文檔写作工具，甚至完全可以用 Sphinx 来写书

• 完备的交叉引用: 语义化的标签，并可以自动化链接函数、类、引文、术语等；
• 明晰的分层结构: 轻松萣义文档树并自动化链接同级/父级/下级文章；
• 美观的自动索引: 可自动生成美观的模块索引；
• 精确的语法高亮: 基于 Pygments 自动生成语法高亮；
• 开放的扩展: 支持代码块的自动测试，自动包含 python生成图文文档 的模块自述文档等等。

这个过程包括如下步骤：

这时通过 bash 自动补全（连续两丅 tab），可以看到有几个命令Sphinx 推荐使用 sphinx-quickstart，这是一个设置向导

运行 sphinx-quickstart，以下主要设置项目名称作者名称以及语言（zh_CN）即可，其他默认

Sphinx 生荿 PDF 的过程先将 rst 转换为 tex，再生产PDF这个过程遇到了比较多的坑，最后总结下来过程如下：

使用 fc-list 来获取字体信息修改相应字体设置即可。

简單过了一下整个文档的流程总体来说，Sphinx非常适合用来编写项目文档reStructuredText 比起 Markdown 也有太多的优势，值得推荐