GDQuest / GDQuest/gdscript-docs-maker

Replicate folder structure option for generate-ref script

Open
#87 0 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Python
Stars
297
Forks
26
PR merge metrics
No merged PRs in 30d

Description

**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.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.