Как мне создать оглавление, основанное на директиве .. http на Sphinx (sphinxcontrib.httpdomain)?

Question

Я хотел бы создать оглавление для своей страницы на основе директивы .. http для sphinxcontrib.httpdomain , расширения Sphinx.

Мои «разделы» «определены» директивами .. http:get:: /user, .. http:post:: /user и .. http:delete:: /user Sphinx. Созданная постоянная ссылка для каждого «раздела» будет: #get--ms3-user, #post--ms3-user и #delete--ms3-user

Возможно ли это? Это оглавление будет в виде списка разделов, и когда я нажму на один элемент, я перейду к разделу.

Я пытался найти его в Интернете, но не смог найти то, что могло бы мне помочь.

Я привожу ниже пример моей страницы.

Заранее спасибо.

user.rst

User
****


.. http:get:: /user

   **Example request**:

   .. sourcecode:: http

      GET /ms3/user HTTP/1.1      
      Host: example.com

   **Example response**:

   .. sourcecode:: http

      HTTP/1.1 200 OK
      Content-Type: application/json

      [
        {
          "email": "test@test.com",
          "username": "test",
        }
      ]

   ...


.. http:post:: /user


   **Example request**:

   ...

   **Example response**:

   ...


.. http:delete:: /ms3/user

   **Example request**:

   ...

РЕДАКТИРОВАТЬ 1: Идея

Следующий пример является попыткой создать это оглавление. Этот подход работает, но я построил его вручную. Я хотел бы автоматический подход, если это возможно.

* `GET /ms3/user <#get--ms3-user>`_
* `POST /ms3/user <#post--ms3-user>`_
* `DELETE /ms3/user <#delete--ms3-user>`_

Answer 1

Я не знаю, будет ли это работать с sphinxcontrib-httpdomain, но попробуйте эти предположения:

.. toctree::
    :maxdepth: 2

    user

И если это не сработает, вставьте заголовок раздела над каждой директивой httpв user.rst:

get ms3 user
------------

.. http:get:: /user

И если это все еще не работает, вставьте произвольную цель над заголовком.

.. _get--ms3-user:

get ms3 user
------------

.. http:get:: /user