如何使Sphinx-Build构建更快?

时间:2018-08-23 12:55:24

标签: python-sphinx

sphinx-build documentation说,它仅重建更改的文件。但是在这个项目中,它正在重建每个模块的所有输出文件。 “高级模块代码”阶段花费的时间特别长。 Python源文件完全没有改变,sphinx-apidoc生成的.rst文件也没有改变-我只编辑了其他一些.rst文件。

此项目中有700多个模块,因此sphinx-build花费约20分钟,即使使用-j 8也是如此。我怎样才能更快?

我正在使用的命令是:

sphinx-build -M html source build

还有source/index.rst的相关部分:

.. toctree::
   :maxdepth: 1

   tutorial/index
   library/modules
   development/index
   setup/index
   usage/index
   test_cases/index
   services/index
   troubleshooting
   todo/index

Indices and tables
------------------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

我正在更改services目录中的文件。

2 个答案:

答案 0 :(得分:1)

尝试将navigation_depth theme option从默认值4更改为2,从collapse_navigation更改为True。请参阅注释:

  

将collapse_navigation设置为False并使用高navigation_depth会导致具有许多文件和深层文件结构的项目生成HTML文件,这些文件的文件大小明显更大,并且编译时间更长。”

答案 1 :(得分:1)

我向num = 0 array = [0, 1, 2] while num < 5: newarray = array newarray[0] += 1 print newarray print array num += 1 添加了以下属性:

conf.py

使用此属性,Sphinx不会将源文件复制到输出中(默认情况下,它将源文件复制到“ _sources”中)。

这没有加快构建速度,但是我有一个SSD驱动器。也许如果您有普通文件,则该过程会更快,因为Sphinx必须复制较少的文件。