問題タブ [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.
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
package1
package1.subpackage1
package1.rst
大規模なプロジェクトですべてのサブパッケージを手動でリストするのはスケーラブルではないため、手動で編集したくありません。
javascript - Sphinx-js は .js ファイルからドキュメントを生成しません
Sphinx を使用してプロジェクトのドキュメントを自動生成しようとしています。私のプロジェクトは次のようになります。
バックエンドの自動ドキュメントを生成しましたが、プロジェクト/プロジェクト/フロントエンド/src の JavaScript ファイルに対してそれを実行しようとすると行き詰まりました。sphinx-jsを使いたいのですが、コマンドが
Python ファイルの *.rst に対してのみドキュメントを生成します。
sphinx-js をインストールしました。
このコードをconf.pyに入れます:
拡張機能を更新しました:
ドキュメントには .py ファイルしか含まれていませんが、frontend/src でも表示されるようになりました (確認しました)。
私は何を間違えたのですか?