GDQuest / GDQuest/gdscript-docs-maker

KeyError: 'name' while generating markdown files

Ouverte
#95 4 commentaires 1 réaction 0 personnes assignées Voir sur GitHub
Langage dominant
Python
Étoiles
297
Forks
26
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

**I'm submitting a...**

- [x] 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
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

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Piste de recherche

Commencez par gdscript_docs_maker/__main__.py et gdscript_docs_maker/gdscript_objects.py, en particulier ProjectInfo.from_dict, puis examinez le reference JSON généré pour le projet Godot 4.2.1. Confirmez pourquoi le champ name attendu est absent et vérifiez que la génération de la référence se termine sans le KeyError et produit des fichiers Markdown.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
godot, python
Domaine
documentation
Type d'issue
Bug
Difficulté
3/5
Temps estimé
1-2 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
38/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.