sphinx-http-domain

スフィンクス-HTTP-ドメインRESTfulなHTTPメソッドのドキュメントを可能にする、HTTPドメインを追加するにはスフィンクスのプラグインです。
あなたは、簡単な方法を文書化カーリーブレースのパス内の任意の引数をラップすることができます。
..のhttp：メソッド:: GET / API / fooの/バー/ {ID} / {スラグ}
＆NBSP;：引数番号：ID
＆NBSP;：引数スラグ：スラグ
＆NBSP;指定されたIDに一致するfoobarsのリストを取得します。
クエリ文字列パラメータもサポートされています。
..のhttp：？方法:: GET / API / fooの/バー/ ID
＆NBSP;：のparam ID：ID
＆NBSP;指定されたIDに一致するfoobarsのリストを検索します。
これは、現時点では非常に初歩的かつ実験的なコードです。
インストール
スフィンクス-HTTP-ドメインをインストールピップ実行します。
そして、あなたのconf.pyにsphinx_http_domainを追加します。
拡張子= ['sphinx_http_domain']

この要件：

このパイソン
スフィンクス