Question

我正在尝试使用Sphinx自动生成项目文档。我的项目如下：

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

我已经为后端生成了自动文档，但是在尝试对我的project / project / frontend / 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中看到它们（我检查过）。

我怎么了？

Sphinx-js不会从.js文件生成文档

0 个答案: