使用Sphinx制作的文档,如何导出
前言:
Sphinx 是一种工具,它允许开发人员以纯文本格式编写文档,以便采用满足不同需求的格式轻松生成输出。这在使用 Version Control System 追踪变更时非常有用。纯文本文档对不同系统之间的协作者也非常有用。纯文本是当前可以采用的最便捷的格式之一。
======================== 正文 ========================
在Github上,拿下了CI4的源码,里面有一份用户手册,是原稿,使用的是Sphinx制作的文档;
索性,我也安装了 Python的 easy_install 工具,去安装 Sphinx 和 sphinxcontrib-phpdomain , 就问了要导出这份文档(当然是英文版的文档);
不过在安装的过程中,发现我电脑里确实有了 Python环境(Sphinx要求Py版本起码2.7),其他工具却不是很齐全;
于是,接连下载了 其他依赖工具:
setuptools-37.0.0
MarkupSafe-1.0
Sphinx-1.4.5
直接安装如果出错的话(找不到包),可以直接下载,这里贴一下地址
setuptools-37.0.0 https://pypi.python.org/pypi/setuptools (原网页)
MarkupSafe-1.0 https://pypi.python.org/pypi/MarkupSafe (原网页)
Sphinx-1.4.5 https://pypi.python.org/simple/sphinx/ (原网页)
其中,下载地址为
setuptools-37.0.0
MarkupSafe-1.0
Sphinx-1.4.5
====================== Ad ====================
附上 CI4 的文档地址:
https://github.com/bcit-ci/CodeIgniter4/tree/develop/user_guide_src
另外,如果对于Sphinx 这个工具有兴趣的同学,可以看看 IBM 内部开的一个操作指南~
参考地址: https://www.ibm.com/developerworks/cn/opensource/os-sphinx-documentation/