Javascript 斯芬克斯js不';t从.js文件生成文档
我正在尝试使用Sphinx自动生成项目文档。我的项目看起来像:Javascript 斯芬克斯js不';t从.js文件生成文档,javascript,python,python-sphinx,sphinx-apidoc,Javascript,Python,Python Sphinx,Sphinx Apidoc,我正在尝试使用Sphinx自动生成项目文档。我的项目看起来像: project | |_docs |_build |_source |_venv ... |_project |_backend |_frontend |_node_modules ... |_src 我已经为后端生成了自动文档,但在我的project/project/frontend/src中尝试为javascript文件生成时遇到了问题。
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中看到它们(我已经检查过了)
我做错了什么?建议您按照项目自述的和部分来查找您遗漏的几个步骤。因此,我无法像.py文件那样通过单击自动生成所有这些文档?文档不会自己编写,甚至不会用Python编写。这些工具提供了一个由作者来填充叙述的框架。