4

私は、sphinx-apidoc を使用して Python ソースの docstring から HTML ドキュメントを自動生成する非常に大きなコード ベースに取り組んでいます。docstring は次の形式を使用します。

:param メッセージ: 表示するメッセージ
:type メッセージ: 文字列
:戻り値: フォーマットされた文字列
:rtype: 文字列

Sphinx の HTML ドキュメントを別の方法で整理/表示する必要がありますが、ソース内のドキュメント文字列から自動生成したいと考えています。Sphinx を使用して中間 (xml など) 形式でドキュメントを生成する方法はありますか? これを行う方法が見つかりませんでした。私が何をするか知っている人はいますか?

4

1 に答える 1

6

HTML ビルダーの代わりに「json」ビルダーを使用すると、解析可能な JSON 出力が生成されます。または、独自のビルダーを作成して、必要な形式を作成することもできます (現在のビルダーのリストについては、https://www.sphinx-doc.org/en/master/usage/builders/index.htmlを参照してください)。

于 2012-10-26T20:09:21.497 に答える