Jak możemy osadzać obrazy w dokumentach sfinksa?

Question

Jestem całkiem nowy w użyciu sfinksa, Doing dokumentacji po raz pierwszy dla projektu Pythona. Jak osadzić obraz na przykład w dokumentacji sfinksa?

Answer 1

Z documenation:

Istnieją dwie dyrektywy obrazu: image i figure.

An image to prosty obraz.

A figure składa się z danych obrazu (w tym opcji obrazu), opcjonalnego napisu (pojedynczy akapit) i opcjonalnej legendy (dowolne elementy karoserii). W przypadku nośników wyjściowych opartych na stronach, dane mogą unosić się w inne miejsce, jeśli pomaga to układowi strony.

Przykład image użycia:

.. image:: picture.jpg 
    :width: 200px 
    :height: 100px 
    :scale: 50 % 
    :alt: alternate text 
    :align: right 

Przykład figure Wykorzystanie:

.. figure:: picture.png 
    :scale: 50 % 
    :alt: map to buried treasure 

    This is the caption of the figure (a simple paragraph). 

Answer 2

użyć dyrektywy image, na przykład:

.. image:: example.png 

Ścieżka do obrazka jest w stosunku do pliku. Aby uzyskać więcej informacji, patrz Sphinx documentation.