Replicate folder structure option for generate-ref script

Đang mở

#87 mở ngày 8/7/2021 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó: 4/5
Thời gian dự kiến: 3-5 ngày
Mức phù hợp với người mới: 35/100

Loại issue: Tính năng
Độ rõ ràng: Khá rõ ràng
Mức độ hoạt động: Đình trệ
Công nghệ: godot, python
Lĩnh vực: documentation, tooling

Hướng nghiên cứu

Bắt đầu bằng cách xác định script generate-ref và đọc cách nó hiện tổ chức tài liệu API được tạo. Xác định việc sao chép thư mục và max-depth tùy chọn sẽ ảnh hưởng như thế nào đến đầu ra, sau đó kiểm tra rằng một codebase GDScript lớn được tổ chức theo các thư mục nguồn của nó mà không làm hỏng hành vi tạo hiện có.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

enhancement

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.

Ngôn ngữ chính: Python
Star: 297
Fork: 26
Chỉ số merge pull request: Không có pull request nào được merge trong 30 ngày

Hướng dẫn đóng góp

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

Bắt đầu từ đâu

Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
Fork repository và làm thay đổi trên một nhánh.
Mở pull request có tham chiếu số hiệu của issue.

Issue khác của GDQuest/gdscript-docs-maker

KeyError: 'name' while generating markdown files Đang mở

Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 38/100

GDQuest/gdscript-docs-maker#95 · 4 bình luận · 1 reaction · Mở ngày 15/1/2024
Running gdscript_docs_maker.__main__ on reference.json Đang mở

Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 45/100

GDQuest/gdscript-docs-maker#94 · Mở ngày 20/12/2023
Display errors of scripts in terminal Đang mở

enhancement

Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 55/100

GDQuest/gdscript-docs-maker#86 · 1 reaction · Mở ngày 8/7/2021
index is being generated blank Đang mở

bug

Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 35/100

GDQuest/gdscript-docs-maker#71 · 3 bình luận · Mở ngày 30/11/2020
Add ability to ignore any property based on metadata Đang mở

enhancement

Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 35/100

GDQuest/gdscript-docs-maker#59 · Mở ngày 20/3/2020

Tất cả issue của GDQuest/gdscript-docs-maker

Issue tương tự

validate-structure inspecte challenge/work/.terraform et rend faux les labs qui ont un provider en cache Đang mở

bug

Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100

stephrobert/dsoxlab#238 · Mở ngày 24/9/2026
Uniform probability densities use the upper bound as an interval width Đang mở

Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100

nasa/fmdtools#40 · Mở ngày 24/9/2026
_common_folder() treats a single file as the common folder; single-file archives can't be installed (4.2.8) / crash (master) Đang mở

Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100

sublimehq/package_control#1780 · Mở ngày 24/9/2026
Set 'Sample' input in 'autorun.py' to utilize 'Sample' Tab in eLog Đang mở

Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 65/100

pcdshub/mfx#309 · 2 bình luận · Mở ngày 24/9/2026
niri config file addition does not respect existing optional include Đang mở

Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 70/100

nwg-piotr/nwg-displays#145 · Mở ngày 24/9/2026

Thêm issue về Python