GDQuest / GDQuest/gdscript-docs-maker

Replicate folder structure option for generate-ref script

オープン
#87 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る
enhancement
主要言語
Python
スター
297
フォーク
26
PR マージ指標
30日以内にマージされた PR はありません

説明

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

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

調査の方向性

まず generate-ref スクリプトを見つけ、現在どのように生成された API ドキュメントを整理しているかを読みます。フォルダーの複製とオプションの max-depth が出力にどのような影響を与えるべきかを定義し、その後、大規模な GDScript コードベースが既存の生成動作を壊すことなくソースフォルダーに従って整理されることを確認します。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
godot, python
領域
documentation, tooling
issue の種類
機能追加
難易度
4/5
見積もり時間
3〜5日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
35/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。