Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replicate folder structure option for generate-ref script #87

Open
1 of 2 tasks
clorl opened this issue Jul 8, 2021 · 0 comments
Open
1 of 2 tasks

Replicate folder structure option for generate-ref script #87

clorl opened this issue Jul 8, 2021 · 0 comments
Labels
enhancement New feature or request

Comments

@clorl
Copy link

clorl commented Jul 8, 2021

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.

@NathanLovato NathanLovato added the enhancement New feature or request label Jul 8, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants