KeyError: 'name' while generating markdown files
还没有人认领这个 Issue。
评估
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 新手友好度
- 38/100
- Issue 类型
- 缺陷
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- godot, python
调研方向
从 gdscript_docs_maker/main.py 和 gdscript_docs_maker/gdscript_objects.py 开始，重点检查 ProjectInfo.from_dict，然后检查为 Godot 4.2.1 项目生成的 reference JSON。确认预期的 name 字段为何缺失，并验证参考文档生成可以在没有 KeyError 的情况下完成并生成 Markdown 文件。
由索引模型根据 Issue 内容生成。
描述
I'm submitting a...
- Bug report.
- Feature request.
Bug report
What is the current behavior?
I followed the documentation on the readme to setup the docs-maker but it gives me an error while generating the markdownfiles.
$ git clone https://github.com/GDQuest/gdscript-docs-maker.git
Cloning into 'gdscript-docs-maker'...
$ mkdir -p documentation/api-reference
$ cd gdscript-docs-maker/
$ ./generate_reference ../code/game_dir_containg_the_godot.project_file -o ../documentation/api-reference
Checking parameters
Copying collectors to project directory
Generating reference json data...
Done.
Generating markdown files in ../documentation/api-reference
Error running gdscript_docs_maker. This is the log:
Traceback (most recent call last):
File "/usr/lib/python3.9/runpy.py", line 197, in _run_module_as_main
return _run_code(code, main_globals, None,
File "/usr/lib/python3.9/runpy.py", line 87, in _run_code
exec(code, run_globals)
File "/usr/local/lib/python3.9/dist-packages/gdscript_docs_maker/__main__.py", line 74, in <module>
main()
File "/usr/local/lib/python3.9/dist-packages/gdscript_docs_maker/__main__.py", line 35, in main
project_info: ProjectInfo = ProjectInfo.from_dict(data)
File "/usr/local/lib/python3.9/dist-packages/gdscript_docs_maker/gdscript_objects.py", line 93, in from_dict
return ProjectInfo(data["name"], data["description"], data["version"])
KeyError: 'name'
This also happens when run as root.
Im on Debian GNU/Linux 11 and the project as well as the server generating the docs is using Godot 4.2.1.stable.official.b09f793f5
- 主要语言
- Python
- 星标
- 297
- 派生
- 26
- PR 合并指标
- 30 天内没有已合并 PR
环境准备
我们还没有检查这个项目的环境配置文件。先看它的 README，通用步骤见我们的新手贡献指南。
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
GDQuest/gdscript-docs-maker 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 45/100
-
enhancement
难度 4/5 3-5 天 新手友好度 35/100
-
enhancement
难度 2/5 1-3 小时 新手友好度 55/100
GDQuest/gdscript-docs-maker#86 · 1 个 reaction ·
-
bug
难度 3/5 1-2 天 新手友好度 35/100
GDQuest/gdscript-docs-maker#71 · 3 条评论 ·
-
enhancement
难度 5/5 一周以上 新手友好度 35/100
查看 GDQuest/gdscript-docs-maker 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 76/100
PedestrianDynamics/pyFDS-Evac#199 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 65/100
521xueweihan/HelloGitHub#3790 ·
-
难度 2/5 1-3 小时 新手友好度 78/100
sandialabs/atlas-ui-3#978 ·
维护者通常 1 天内回复
-
area: tests perceived difficulty: 2
难度 2/5 1-3 小时 新手友好度 72/100
Nitjsefnie-Harness-Commons/daedalus#1255 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 86/100
EleutherAI/lm-evaluation-harness#4256 ·
维护者通常 1 天内回复