問題タブ [sphinx-apidoc]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票する
0 に答える
438 参照

python - sphinx-apidoc は、生成されたファイルにサブパッケージを含めません

私のディレクトリは次のとおりです(適切な__init__.pyファイルはここにリストされていません):

実行sphinx-apidoc . --full -o docs -H 'MyProject' -A 'MyName' -V '1.0'すると、必要なほとんどすべてが得られます。

  • index.rst
  • package1.rst
  • package1.subpackage1.rst
  • package2.rst

indexリストしますが、リストpackage1しません。package2 package1package1.subpackage1

package1.rst大規模なプロジェクトですべてのサブパッケージを手動でリストするのはスケーラブルではないため、手動で編集したくありません。

0 投票する
0 に答える
1097 参照

javascript - Sphinx-js は .js ファイルからドキュメントを生成しません

Sphinx を使用してプロジェクトのドキュメントを自動生成しようとしています。私のプロジェクトは次のようになります。

バックエンドの自動ドキュメントを生成しましたが、プロジェクト/プロジェクト/フロントエンド/src の JavaScript ファイルに対してそれを実行しようとすると行き詰まりました。sphinx-jsを使いたいのですが、コマンドが

Python ファイルの *.rst に対してのみドキュメントを生成します。

sphinx-js をインストールしました。

このコードをconf.pyに入れます:

拡張機能を更新しました:

ドキュメントには .py ファイルしか含まれていませんが、frontend/src でも表示されるようになりました (確認しました)。

私は何を間違えたのですか?