GDQuest / GDQuest/gdscript-docs-maker
KeyError: 'name' while generating markdown files
まだ誰も着手していません。
- 主要言語
- Python
- スター
- 297
- フォーク
- 26
- PR マージ指標
- 30日以内にマージされた PR はありません
説明
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
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
gdscript_docs_maker/main.py と gdscript_docs_maker/gdscript_objects.py から始め、特に ProjectInfo.from_dict を確認してから、Godot 4.2.1 プロジェクト用に生成された reference JSON を調べてください。期待される name フィールドが存在しない理由を確認し、参照生成が KeyError なしで完了して Markdown ファイルを生成することを検証してください。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- godot, python
- 領域
- documentation
- issue の種類
- バグ
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 38/100