GDQuest / GDQuest/gdscript-docs-maker

Replicate folder structure option for generate-ref script

Abierto
#87 0 comentarios 0 reacciones 0 asignados Ver en GitHub
enhancement
Lenguaje dominante
Python
Estrellas
297
Forks
26
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

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

- [ ] Bug report.
- [x] 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.

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

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.

Evaluación

Stack tecnológico
godot, python
Área
documentation, tooling
Tipo de issue
Nueva funcionalidad
Dificultad
4/5
Tiempo estimado
3-5 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.