Replicate folder structure option for generate-ref script
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Aptitud para principiantes
- 35/100
- Tipo de issue
- Nueva funcionalidad
- Claridad
- Bastante claro
- Estado de actividad
- Estancado
- Stack tecnológico
- godot, python
- Área
- documentation, tooling
Línea de trabajo
Comienza localizando el script generate-ref y leyendo cómo organiza actualmente la documentación de API generada. Define cómo deberían afectar a la salida la replicación de carpetas y una max-depth opcional, y después verifica que una base de código grande de GDScript se organice según sus carpetas de origen sin romper el comportamiento de generación existente.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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.
- Lenguaje dominante
- Python
- Estrellas
- 297
- Forks
- 26
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de GDQuest/gdscript-docs-maker
-
Dificultad 3/5 1-2 días Aptitud para principiantes 38/100
GDQuest/gdscript-docs-maker#95 · 4 comentarios · 1 reacción ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 45/100
-
enhancement
Dificultad 2/5 1-3 horas Aptitud para principiantes 55/100
GDQuest/gdscript-docs-maker#86 · 1 reacción ·
-
index is being generated blank Abiertobug
Dificultad 3/5 1-2 días Aptitud para principiantes 35/100
GDQuest/gdscript-docs-maker#71 · 3 comentarios ·
-
enhancement
Dificultad 5/5 Más de una semana Aptitud para principiantes 35/100
Todos los issues de GDQuest/gdscript-docs-maker
Issues similares
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
stephrobert/dsoxlab#238 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
sublimehq/package_control#1780 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 65/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
nwg-piotr/nwg-displays#145 ·