How do we embed images in sphinx docs?

前端 未结 3 1660
礼貌的吻别
礼貌的吻别 2020-12-25 10:18

I am quite new in using sphinx, Doing documentation for the first time for the python project. How to embed image for example in the sphinx documentation ?

3条回答
  •  一向
    一向 (楼主)
    2020-12-25 10:25

    In case anyone is looking to include an inline image, the following works:

    The |biohazard| symbol must be used on containers used to dispose of medical waste.
    
    .. |biohazard| image:: biohazard.png
    

    (From https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#substitution-definitions)

提交回复
热议问题