Replicate folder structure option for generate-ref script
まだ誰も着手していません。
評価
- 難易度
- 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 にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
GDQuest/gdscript-docs-maker のほかの issue
-
難易度 3/5 1〜2日 初心者へのやさしさ 38/100
GDQuest/gdscript-docs-maker#95 · コメント 4 件 · リアクション 1 件 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 45/100
-
enhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 55/100
GDQuest/gdscript-docs-maker#86 · リアクション 1 件 ·
-
bug
難易度 3/5 1〜2日 初心者へのやさしさ 35/100
GDQuest/gdscript-docs-maker#71 · コメント 3 件 ·
-
enhancement
難易度 5/5 1週間以上 初心者へのやさしさ 35/100
GDQuest/gdscript-docs-maker の issue をすべて見る
似ている issue
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
stephrobert/dsoxlab#238 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
sublimehq/package_control#1780 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
nwg-piotr/nwg-displays#145 ·