Sphinx を使用してプロジェクトのドキュメントを自動生成しようとしています。私のプロジェクトは次のようになります。
project
|
|_docs
|_build
|_source
|_venv
...
|_project
|_backend
|_frontend
|_node_modules
...
|_src
バックエンドの自動ドキュメントを生成しましたが、プロジェクト/プロジェクト/フロントエンド/src の JavaScript ファイルに対してそれを実行しようとすると行き詰まりました。sphinx-jsを使いたいのですが、コマンドが
make html
Python ファイルの *.rst に対してのみドキュメントを生成します。
sphinx-js をインストールしました。
npm install jsdoc
pip install sphinx-js
このコードをconf.pyに入れます:
import os
import sys
sys.path.insert(0, os.path.abspath('../../project/backend/'))
sys.path.insert(0, os.path.abspath('../../'))
js_source_path = '../project/frontend/src/'
import django
os.environ['DJANGO_SETTINGS_MODULE'] = 'project.settings'
django.setup()
拡張機能を更新しました:
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.doctest',
'sphinx.ext.coverage',
'sphinx.ext.mathjax',
'sphinx.ext.ifconfig',
'sphinx.ext.viewcode',
'sphinx.ext.githubpages',
'sphinx_js'
]
ドキュメントには .py ファイルしか含まれていませんが、frontend/src でも表示されるようになりました (確認しました)。
私は何を間違えたのですか?