1

我正在尝试使用 Sphinx 自动生成项目的文档。我的项目看起来像：

project 
  |
  |_docs
    |_build
    |_source
  |_venv
  ...
  |_project
    |_backend
    |_frontend
      |_node_modules
      ...
      |_src

我已经为后端生成了自动文档，但是在尝试为我的项目/项目/前端/src 中的 javascript 文件执行此操作时遇到了困难。我想使用 sphinx-js，但是命令

make html

仍然只为 *.rst 的 python 文件生成文档。

我已经安装了 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 中看到它们（我检查过）。

我做错了什么？

4

0 回答 0