label en python docstring

Question

J'utilise sphinx autodoc pour traduire mon docstring vers une page de documentation sympa. Dans la docstring, je suis la ligne directrice docsh de numpy en utilisant l'extension sphinx napoleon. Je me demande sur les points suivants: Si j'ai une équation comme

""" 
This is a very important equation which is used in the code 

.. math:: 

    a+b=c 
    :label: important_eq 
""" 

le autodoc ne reconnaît pas le :label:. Ai-je un mauvais format ou ne peux-je pas traiter autodoc/mathjax/napoleon avec des étiquettes dans des équations?

Answer 1

Soyez prudent avec les espaces et l'indentation. Cela fonctionne:

.. math:: 
    :label: important_eq 

    a+b=c 

Cela fonctionne aussi (lorsque la teneur en mathématiques est une seule ligne de texte, il peut être donné comme argument de directive):

.. math:: a+b=c 
    :label: important_eq