========================== window10搭建sphinx环境总结 ========================== 搭建python环境 ========================== + 下载python 安装python环境请在 python官网_ 下载最新版本的python进行安装。 .. note:: | 最好选择3.7以上版本的python,因为3.7以上版本自动安装pip(安装sphinx时使用)和easy_install(很多文章介绍用easy_install安装,但实测windows10下用easy_install安装失败)。 | 如果是64位系统,需要选择x64版本安装 .. _python官网: https://www.python.org/downloads/windows/ + 安装python 下载python后,直接点击安装即可。 **说明** windows10环境默认安装在“C:\Users\duoduo\AppData\Local\Programs\Python\Python37\”这个目录下,AppData为隐藏目录,需要去掉目录的隐藏属性才能看到。 搭建sphinx环境 ========================== | 如果安装的是python3.7以上版本,环境变量无需手动设置,python安装完成,环境变量就已自动设置。python安装完成后,在cmd窗口执行如下命令安装sphinx: | pip install -U sphinx **说明** 测试使用pip命令安装sphinx成功。很多文章介绍用easy_install安装shnix,实际测试在安装过程中失败。用easy_install尝试了3次都失败。 修改sphinx固有模板 ====================== 1. windows10环境下,sphinx模板文件保存在如下目录:C:\\Users\\duoduo\\AppData\\Local\\Programs\\Python\\Python37\\Lib\\site-packages\\Sphinx-2.0.1-py3.7.egg\\sphinx\\templates\\ 2. 后缀名为“.tex_t”结尾的即为sphinx的模板文件,sphinx会按该模板生成tex文件,最终生成pdf文件,因此修改该模板文件即影响tex文件的生成。 3. latex目录下保存有基本的table模板和sphinx自定义模板。 4. quickstart文件下保存有生成工程文件夹所需要的模板。 修改latex.tex_t模板实例如下,增加了xcolor包的支持,便于给表格设置背景色: .. image:: ../image/note.png 非sphisnx包一定要放在sphinx包之前,否则生成pdf会出错。 .. code-block:: :emphasize-lines: 1 \usepackage[table]{xcolor} \usepackage<%= sphinxpkgoptions %>{sphinx} 修改tabulary.tex_t模板,添加rowcolor参数,给表格第一行和其它行添加背景色: .. code-block:: :emphasize-lines: 1,3 \rowcolors{2}{white!10}{gray!10} \begin{tabulary}{\linewidth}[t]<%= table.get_colspec() -%> \rowcolor{blue!60} \hline <%= ''.join(table.header) %> <%=- ''.join(table.body) %> \end{tabulary}