本文共 1079 字，大约阅读时间需要 3 分钟。

如果没有听过Sphinx，Please Read The Fuck Documents（RTFD）。

Sphinx 展示：

Spinx 官网：

1.安装sphinx

sudo apt-get install python-pipsudo pip install sphinx sphinx_rtd_theme

安装sphinx_rtd_theme 会使得你的文档看起来更高大上，目前linux 主线文档就使用的是这一款风格。

2.使用github或者gitlab来创建一个repo，clone到本地。

3.执行命令一直按回车，输入书名，作者，version

sphinx-quickstart

4.修改主题风格：

cd sourcevim conf.pyhtml_theme = ‘sphinx_rtd_theme’  修改主题风格

5. 展示自己的文档：

这个网站能够展示你代码版本库中的sphinx文件，同时提供download。

创建项目有两种方式：1>.Connected Services + Import a Repo

2>. Import manually (在url中嵌入你的密码。eg：https://sholck:passwd@gitlab.com/sholck/my-book-Android-audio.git)

Documentation type选择 Sphinx HtmlDir

6.编写规范：注意 普通文本 与 格式文本 中间空行

嵌入其他页面

Welcome to Sholck's documentation!==================================This is a planet for my flowers and dogs.. toctree::    :maxdepth: 2    index/hello

嵌入图片

hello-world===========心中有天地，不为外物欺.. figure:: 1.jpg    :align: center

嵌入代码文件（行数+着重显示）代码类型风格高亮尚未成功

耳机连接 日志.. highlight:: c.. literalinclude:: doc/ear-conn.c    :linenos:    :emphasize-lines: 1-

目前存在的问题

1. 无法实现像 100%占屏，所以导致一些代码文件显示时出现滑动条。

2.嵌入外部文件代码无法高亮，使用下面的语句make html出错。

:language: c

转载地址：http://ibgji.baihongyu.com/