sphinx安装及简单使用

如果你要编写技术文档, 可以用 reStructuredText 或 Markdown 格式编辑文件，然后使用 Sphinx 工具转换成 html, PDF, ePub等格式，或者托管到 github 并导入 readthedocs 网站。

安装软件包（需要先安装 Python）
```
pip install sphinx sphinx_intl sphinx_rtd_theme recommonmark
```
sphinx: 文档生成工具
sphinx_intl: 多语言工具
recommonmark: sphinx支持markdown的插件
sphinx_rtd_theme: sphinx的readthedocs主题插件
创建存放文档的目录，执行 sphinx-quickstart 命令
```
cd /path/to/project
mkdir docs
cd docs
sphinx-quickstart
```
sphinx-quickstart 会创建基本配置。一般情况下，你只要接受默认值就行了。当上述命令执行完后，在 docs目录下，你会找以 index.rst和 conf.py。你可以编辑这两个文件，加入一些项目信息。

Makefile : 批处理指令，使用 make 命令时，用来构建文档输出。
_build : 用于存放最终生成的文档。
_static : 所有不属于文档源代码的文件（如图像）均存放于此处，构建时会它们链接在一起。
conf.py : 一个 Python 文件，存放 Sphinx 的配置值，包括执行 sphinx-quickstart 时选中的那些值。
index.rst : 文档项目的 root 目录。如果将文档有多个文件，该目录会连接这些文件。
修改conf.py，加入 Markdown 支持
```
extensions = ['recommonmark']
```

修改 conf.py，使用 sphinx_rtd_theme 风格。修改

html_theme = 'alabaster'

为

import sphinx_rtd_theme
html_theme = "sphinx_rtd_theme"
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

执行命令，生成输出
```
make html
```
输出的html文件在 docs\_build\html目录下，打开 index.html即可。

sphinx安装及简单使用相关推荐

Sphinx安装与基本设置
Sphinx安装与基本设置 Sphinx是什么?如果你还不知道,那就放狗吧- 简单引用一下官方wiki的文章: Sphinx是一个基于SQL的全文检索引擎,可以结合MySQL,PostgreSQL做全 ...
docker-compose的安装与简单使用
docker-compose的安装与简单使用 docker-compose简介屁话不这么多,直接开干 docker-compose安装步骤由于docker-compose托管在github上面,所 ...
内核同步对性能的影响及perf的安装和简单的使用
更多文章目录:点击这里 GitHub地址:https://github.com/ljrkernel 内核同步对性能的影响及perf的安装和简单的使用看了一篇关于多线程应用程序性能分析的外文,结合之前 ...
cakephp 安装mysql_CakePHP的安装的简单方法
在对于CakePHP的作用有了初步认识后,我们可以下载CakePHP来进行一些使用.在安装前,要检查php的版本情况,防止CakePHP框架出现不适配的情况. 对于具体的框架组装,会涉及到依赖库和Co ...
怎么进入python官网-Python的安装及简单的使用
原标题:Python的安装及简单的使用像我们想要抓住一门好的编程语言,如何开始学习呢?我来简单介绍下python Python特性:语法简单,入门上手快,很多女神也在学习,方便找个编程的妹纸---- ...
刚安装的python如何使用-Python requests的安装与简单运用
强烈推荐!requests官方文档已有了中文版,请见http://cn.python-requests.org/zh_CN/latest/ . requests是python的一个HTTP客户端库,跟 ...
python requests的安装与简单运用
强烈推荐!requests官方文档已有了中文版,请见http://cn.python-requests.org/en/latest/. requests是python的一个HTTP客户端库,跟urll ...
memcache的windows下的安装和简单使用
原文:memcache的windows下的安装和简单使用 memcache是为了解决网站访问量大,数据库压力倍增的解决方案之一,由于其简单实用,很多站点现在都在使用memcache,但是memcach ...
Oracle数据库学习（一）安装和简单使用
新公司的新项目,需要用到Oracle数据库,所以现在便来解除此数据库,不得不说,这个数据库还这是麻烦. 安装倒是简单,就是中间会遇到各种问题. 安装步骤参考:https://blog.csdn.net ...
1.Vue 安装与简单使用
Hello,我是 Alex 007,一个热爱计算机编程和硬件设计的小白,为啥是007呢?因为叫 Alex 的人太多了,再加上每天007的生活,Alex 007就诞生了. 1.Vue的安装与简单使用这 ...

sphinx安装及简单使用

sphinx安装及简单使用

sphinx安装及简单使用相关推荐

最新文章

热门文章