9

PyCharm に Python プロジェクトがあり、Python コードとドキュメント文字列から API ドキュメントを (HTML 形式で) 自動的に生成したいと考えています。

このページによると、Python API ドキュメントを生成するツールは多数あります。

  • オートサマリー
  • オートドック
  • pdoc
  • PyDoc
  • パイドクター
  • ドキシジェン

このページには、次のツールが「ドキュメントを処理する」ことも記載されています。

  • DocUtils
  • スフィンクス

PyCharmのドキュメントには、DocUtils と Sphinx を使用して「フォーマットされた API ドキュメントを作成する」ことができると書かれています。ただし、これらのツールはファイルではなくファイルのみを処理する構成を示しているため、これは正しくないようです。*.rst*.py

私の質問はこれです: PyCharm の DocUtils または Sphinx 機能を使用して API ドキュメントを生成できますか?

それができない場合、これを行うために PyCharm の機能を使用できますか?

それができない場合、これを行うための PyCharm とうまく統合できるツールはありますか?

4

1 に答える 1