搭建工具
Sphinx 是一个基于 Python 的文档生成工具,最早只是用来生成 Python 官方文档,随着工具的完善,越来越多的知名的项目也用他来生成文档,甚至完全可以用他来写书。例如我最近看到 tensorly 等库都有包括 Github 主页,Jupyter Notebook, 以及 Read the Docs 代码 API 说明。
搭建步骤
pip install sphinx sphinx-autobuild sphinx_rtd_theme
- 新建一个 Github 仓库,并拉到本地,仓库名设为项目名。
- 命令行进入仓库本地目录,输入
sphinx-quickstart
这个是项目的配置文件,这里要改动的是项目名,版本,以及语言。其他的默认即可。生成下面目录结构。 - 进入目录下面的 conf.py,可以看到我们刚才的配置的内容就是在配置这个文件。下面继续修改。 首先把源文件改为使用习惯的 Markdown 文件,
source_suffix = \'.md\'
然后把主题换了,html_theme = \'sphinx_rtd_theme\'。
最后把 LaTeX 内容配置一下。 - 进入命令行 make html
- 提交目录到 Github。
- 打开 Read the Docs, 并使用 Github 注册,导入项目并点击阅读文档即可。 也可以在 GitHub 里选择仓库,然后依次点击 Setting => Webhooks & Service => Add service => ReadTheDocs, 激活这个选项。