PythonSphinx文档覆盖现有项目,KeyError u'language'

2024-06-16 12:32:55 发布

您现在位置:Python中文网/ 问答频道 /正文

我正在尝试在我已经完成的FlaskWeb应用程序上实现Sphinx文档。 当我尝试使用以下命令运行Sphinx时:

sphinx-apidoc -F -A "MonitoringApplication" -V "0.1" -o docs App

它为python脚本创建rst文件,但退出时出现以下错误: 在:Sphinx\quickstart.py, line 1328, in generate conf_text = QUICKSTART_CONF % d KeyError: u'language

谷歌在这个错误上对我没什么好处,所以我来了这里! 额外信息:

斯芬克斯版本1.3b1-py2.7, 操作系统:windows7,Sphinx在虚拟环境中运行(venv)

项目目录示例:

App/
  --MoitoringApplication.py
  --models.py
  --database.py
  --functions.py
  --etc.py
  templates/
    --index.html
    --overview.html
    --etc.html
  static/
    --jquery.js
    --etc.js
    images/
      --logo.jpg

运行Sphinx apidoc命令将生成以下目录:

^{pr2}$

我是使用了错误的命令,还是我的目录顺序不正确,或者我需要的是另一个Sphinx版本? 谢谢你的时间。在


Tags: 文档py命令版本目录app应用程序html
2条回答

例如,Sphinx配置中的语言:

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
language = 'de'

我发现我在包里漏掉了__init__.py。在

还需要在config.py中添加sys.path.append("../App")。在

然后使用sphinx apidoc生成新的.rst文件。在

然后{}对我有用。在

相关问题 更多 >