Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Replicate folder structure option for generate-ref script

Aperta
#87 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
35/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
godot, python
Ambito
documentation, tooling

Direzione di ricerca

Inizia individuando lo script generate-ref e leggendo come organizza attualmente la documentazione API generata. Definisci in che modo la replica delle cartelle e una max-depth opzionale dovrebbero influire sull’output, quindi verifica che una grande codebase GDScript sia organizzata in base alle relative cartelle sorgente senza compromettere il comportamento di generazione esistente.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

enhancement

I'm submitting a...

  • Bug report.
  • Feature request.

Feature request

Concepts of namespaces don't exist in GDScript, however, it's useful in an API reference to have sections separated by themes or namespaces, for specific areas of the API.

The generate-ref script could benefit from a "replicate folder structure" option, where the project's folder structure is replicated inside generated docs. It would allow large codebases API to be structured in the same way and be easier to navigate. Specifying a max-depth could also be useful, as one could just want to sort API docs by top-level folder structure.

Lingua principale
Python
Stelle
297
Fork
26
Nessuna PR unita negli ultimi 30g

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di GDQuest/gdscript-docs-maker

Tutte le issue di GDQuest/gdscript-docs-maker

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.