15

我目前正在记录一个用 Python 编写的 rest API。所有项目的文档都是使用 Sphinx 创建的，对于 REST API，我想创建一些特殊的指令。例如，假设我定义了这个资源：

@resource("/user/<email>", method="GET")
def user_details (email):
    """ Returns detailed information about a user account.

    :resource GET: /user/<email>
    :query_param a_param: Some kind of query param.
    """
    # Do stuff and return user details

这基本上就是文档当前的样子。我希望能够为 Sphinx 创建一个指令，该指令格式化一个或多个，:query_param ...:就像它对常规的那样:param:。

我已经找到了如何制作角色，但它们只能内联工作，而不适用于数据块。

我该怎么做这个？

4

1 回答 1

13

Sphinx 可以通过“ Sphinx Extensions ”使用自定义指令进行扩展。也就是说，您需要实现一个提供query_param自定义指令的 Sphinx 扩展，并将此扩展添加到您的 Sphinx 项目中。

Sphinx 文档提供了关于实现扩展的教程，其中它们确实实现了自定义指令。

参考：

http://www.sphinx-doc.org/en/stable/extensions.html

http://www.sphinx-doc.org/en/stable/extdev/index.html#dev-extensions

于 2012-10-11T09:41:55.577 回答