当autodoc导入失败时,如何故意使Sphinx构建失败

时间:2015-09-11 14:43:30

标签: python jenkins python-sphinx autodoc

我有一个CI(Jenkins)工作,为我的Python项目构建Sphinx文档:

#!/bin/bash
set -x
virtualenv $WORKSPACE
source $WORKSPACE/bin/activate
pip install 'sphinx>=1.3.1'
python setup.py build_sphinx

我的项目使用Sphinx autodoc扩展程序通过导入来从我的模块中提取文档字符串,例如在" docs / api / foo.bar.rst":

.. automodule:: foo.bar
    :members:
    :undoc-members:
    :show-inheritance:

现在,如果autodoc无法导入foo.bar,则Sphinx构建会在日志中显示回溯并继续构建,尽管它警告我:

WARNING: toctree contains reference to document u'api/foo.bar' that doesn't have a title: no link will be generated

这导致文档丢失,因此我想在此事件中使我的Sphinx构建步骤失败。有没有比尝试从build_sphinx grep日志更优雅的方法?

0 个答案:

没有答案