15

私は現在、Python で書かれた残りの 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

これが基本的に、ドキュメントが現在どのように見えるかです。通常: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 に答える