Referencing figures with numbers in Sphinx and reStructuredText

前端 未结 5 1312
挽巷
挽巷 2020-12-14 06:43

When writing RST that will be processed with Sphinx, I can\'t get Sphinx LaTeX output to use figure numbers when referencing figures. For instance, this code:



        
5条回答
  •  攒了一身酷
    2020-12-14 07:08

    In the latest versions of Sphinx (1.3+), numbering figures and referencing them from text got a bit easier as support for it is now built-in.

    In your text, you can do something like:

    .. _label:
    .. figure:: images/figure.*
    
    
    At :numref:`label` you can see...
    

    The end result should be something like "At Fig 1.1 you can see...". This technique works both with the default HTML output and the LaTeX output.

    In your conf.py file, make sure to set the flag numfig = True. There are also configuration options for the references' text format (numfig_format and numfig_secnum_depth).

    References:

    • http://www.sphinx-doc.org/en/stable/config.html#confval-numfig
    • https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#cross-referencing-figures-by-figure-number

提交回复
热议问题