如何根据Sphinx上的'.. http'指令创建目录（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

可能吗？这个TOC将作为一个部分列表，当我点击一个项目时，我将转到“部分”。

我试图在互联网上寻找它，但我找不到可以帮助我的东西。

我在下面给出了我的页面示例。

先感谢您。

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": "[email protected]",
          "username": "test",
        }
      ]

   ...


.. http:post:: /user


   **Example request**:

   ...

   **Example response**:

   ...


.. http:delete:: /ms3/user

   **Example request**:

   ...

编辑1：一个想法

以下示例是尝试创建此TOC。这种方法有效，但我是手动构建的。如果可能的话，我想要一种自动方法。

* `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