image - 指定 Sphinx(重组文本)格式的在线图像

Question

关于如何在使用 Sphinx 进行记录时引用在线图像的任何想法？

这不起作用:

.. image:: http://www.mysite.com/images/someimage.png

给我:

/home/user/proj/2010/11/08/the_forever_war.rst:11: WARNING: nonlocal image URI found: http://www.mysite.com/images/someimage.png

谢谢...

Answer 1

从 sphinx 1.4 开始，您可以从 docs/conf.py 中“猴子补丁”sphinx像这样的文件:

import sphinx.environment
from docutils.utils import get_source_line

def _warn_node(self, msg, node, **kwargs):
    if not msg.startswith('nonlocal image URI found:'):
        self._warnfunc(msg, '%s:%s' % get_source_line(node), **kwargs)

sphinx.environment.BuildEnvironment.warn_node = _warn_node

此答案的先前版本提供了与最新的 sphinx 1.4 版本不兼容的补丁[1]。此外，sphinx 的下一个版本应该支持这个配置选项[2]:

suppress_warnings = ['image.nonlocal_uri']

这将排除“找到非本地镜像 URI”的任何警告。

我发现这是必要的，因为我想要 sphinx-build -W到
作为我的测试和构建基础设施的一部分，发出“警告作为错误”，
确保文档中没有错误——我
非常清楚我使用的是非本地镜像 URI，我可以接受
那，但我不想忽略其他警告。

[1] https://github.com/sphinx-doc/sphinx/issues/2429#issuecomment-210255983

[2] https://github.com/sphinx-doc/sphinx/issues/2466