Numérotation / légendes d'images automatisées Sphinx?

Question

Existe-t-il un moyen de générer automatiquement une légende d'image / de figure à l'aide de sphinx?

J'ai actuellement des fichiers reste-sphinx que je convertis au format HTML et pdf (latex) à l'aide de sphinx.

J'aimerais que les utilisateurs puissent facilement référencer une image spécifique dans les fichiers HTML / pdf résultants. Par exemple, si un utilisateur fait référence à la documentation dans un courrier électronique, l'option "Dans 'Image 65' indique XXX, mais cela ne fonctionne pas pour moi".

J'ai essayé d'utiliser figure où il apparaît pour vous permettre d’appliquer une légende à une image, mais cela doit être ajouté manuellement. (Et j’ai du mal à le faire fonctionner avec une substitution pour une raison quelconque).

Existe-t-il une méthode repos-sphinx que j'oublie qui permettrait d'atteindre cet objectif? Ou bien, existe-t-il un moyen de modifier / modifier les modèles existants de sphinx pour ajouter cette capacité?

Answer 1

Sphinx utilise reStructuredText selon les modèles de Jinja . Toutefois, selon la documentation Sphinx, vous disposez d'autres options de modèle .

Vous devriez pouvoir utiliser les structures de contrôle de Jinja dans un modèle personnalisé pour obtenir l’effet recherché.