Replicate folder structure option for generate-ref script
还没有人认领这个 Issue。
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 35/100
- Issue 类型
- 功能
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- godot, python
- 领域
- documentation, tooling
调研方向
首先定位 generate-ref 脚本，并阅读它当前如何组织生成的 API 文档。定义文件夹复制和可选的 max-depth 应如何影响输出，然后验证大型 GDScript 代码库是否按照其源文件夹进行组织，同时不破坏现有的生成行为。
由索引模型根据 Issue 内容生成。
描述
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.
- 主要语言
- Python
- 星标
- 297
- 派生
- 26
- PR 合并指标
- 30 天内没有已合并 PR
贡献指南
这个仓库没有索引到贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
GDQuest/gdscript-docs-maker 的其他 Issue
-
难度 3/5 1-2 天 新手友好度 38/100
GDQuest/gdscript-docs-maker#95 · 4 条评论 · 1 个 reaction ·
-
难度 2/5 1-3 小时 新手友好度 45/100
-
enhancement
难度 2/5 1-3 小时 新手友好度 55/100
GDQuest/gdscript-docs-maker#86 · 1 个 reaction ·
-
bug
难度 3/5 1-2 天 新手友好度 35/100
GDQuest/gdscript-docs-maker#71 · 3 条评论 ·
-
enhancement
难度 5/5 一周以上 新手友好度 35/100
查看 GDQuest/gdscript-docs-maker 的全部 Issue
相似的 Issue
-
agent-ready documentation needs-triage
难度 1/5 1-3 小时 新手友好度 88/100
-
documentation
难度 1/5 1 小时以内 新手友好度 91/100
-
workflow-status page template still says reusable workflows are "triggered only by workflow_call:" 未关闭
难度 1/5 1 小时以内 新手友好度 92/100
-
instance instance add
难度 1/5 1 小时以内 新手友好度 72/100
searxng/searx-instances#939 · 1 条评论 ·
-
area-deployment area-integrations triage:bot-seen
难度 2/5 半天 新手友好度 86/100