Frage Angeben eines Online-Bildes im Sphinx-Format (restructuredtext)


Irgendwelche Ideen, wie ich bei der Dokumentation mit Sphinx auf ein Online-Bild verweisen kann?

Das funktioniert nicht:

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

Gibt mir:

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

Vielen Dank...


10
2017-10-07 21:15


Ursprung


Antworten:


Ab Sphinx 1.4 können Sie Sphinx "Affe Patch" von Ihrem docs/conf.py Datei so:

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

Eine frühere Version dieser Antwort enthielt einen Patch, der mit der neuesten sphinx 1.4-Version nicht kompatibel ist [1]. Außerdem sollte die nächste Version von sphinx diese Konfigurationsoption unterstützen [2]:

suppress_warnings = ['image.nonlocal_uri']

Dies schließt alle Warnungen von 'nicht lokalem Image-URI' aus.

Ich fand das notwendig, weil ich das möchte sphinx-build -W zu "Warnungen als Fehler" als Teil meiner Test & Build-Infrastruktur ausgeben, um sicherzustellen, dass es in der Dokumentation keine Fehler gibt - I weiß sehr gut, dass ich nichtlokale Bild-URIs verwende und damit einverstanden bin das, aber ich möchte die anderen Warnungen nicht ignorieren.

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

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


19
2018-02-28 06:40



Ich benutze dafür den Roh-HTML-Code.

.. raw:: html

   <p style="height:22px">
     <a href="https://travis-ci.org/aio-libs/aiozmq" >
       <img src="https://travis-ci.org/aio-libs/aiozmq.svg?branch=master"/>
     </a>
   </p>

6
2018-03-27 18:41



Das ist ziemlich peinlich ...

Wie oben in seinem Kommentar erwähnt, erhalte ich nur eine Warnung.

Zu meiner Verteidigung habe ich einige ziemlich komplizierte rohe Anweisungen ausprobiert, bevor ich mich auf die Bildanweisung festgelegt habe, und ich habe nur die Ausgabe von Sphinx auf den gerenderten Seiten betrachtet. Als ich die lange Ausgabe von Sphinx sah, nahm ich an, dass ich wieder einen Fehler hatte.

Trotzdem bin ich schuld ... Das Bild lädt gut.


4
2017-10-07 21:46