Как пронумеровать предупреждения в Sphinx?

Question

Я пишу книгу, используя Sphinx Documentation, и у меня есть специальный admonition, который используется довольно часто. Но для лучшего общения с другими авторами я хотел бы иметь автоматический номер в каждом из этих специальных предупреждений.

Say I вход это:

Section 
======= 

.. admonition:: Observation 

    text 

.. admonition:: Observation 

    text 

Я хотел бы получить что-то подобное для HTML сборки:

<h2>Section</h2> 

<div class="admonition-observation admonition"> 
<p class="first admonition-title">Observation 1</p> 
<p>text</p> 

<div class="admonition-observation admonition"> 
<p class="first admonition-title">Observation 2</p> 
<p>text</p> 

Или что-нибудь, что дает мне автоматическую нумерацию в источнике HTML (аналогично для источника латекса).

Answer 1

Один из способов сделать это, чтобы использовать расширение, как https://github.com/rhopfer/sphinx-numbered-blocks

После того установлен, conf.py для вашего подхода может выглядеть следующим образом:

... 
numbered_blocks = [ 
    {'name': 'observation'}, 
] 
... 

Затем в источнике, вы бы написать это:

.. observation:: 

    This is an observation 

Результат в HTML:

(ваш точный выход может немного отличаться)

См https://git.io/vHQzJ другие примеры конфигурации и как изменить метки.