-
-
Notifications
You must be signed in to change notification settings - Fork 21.6k
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
[Export docs] Move docs to platform folders. #76251
Conversation
Looks good! Also needs these changes for rst doc generation: diff --git a/doc/Makefile b/doc/Makefile
index cc2ebf9881..53c5c7dcb0 100644
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -1,5 +1,5 @@
BASEDIR = .
-CLASSES = "$(BASEDIR)/classes/" "$(BASEDIR)/../modules/"
+CLASSES = "$(BASEDIR)/classes/" "$(BASEDIR)/../modules/" "$(BASEDIR)/../platform/"
OUTPUTDIR = $(BASEDIR)/_build
TOOLSDIR = $(BASEDIR)/tools
JSDIR = "$(BASEDIR)/../platform/web"
diff --git a/doc/tools/make_rst.py b/doc/tools/make_rst.py
index 1f71b77cbd..3655a60c35 100755
--- a/doc/tools/make_rst.py
+++ b/doc/tools/make_rst.py
@@ -567,7 +567,7 @@ def main() -> None:
if path.endswith("/") or path.endswith("\\"):
path = path[:-1]
- if os.path.basename(path) == "modules":
+ if os.path.basename(path) in ["modules", "platform"]:
for subdir, dirs, _ in os.walk(path):
if "doc_classes" in dirs:
doc_dir = os.path.join(subdir, "doc_classes") And this tweak for the docs l10n extractor: godotengine/godot-editor-l10n#4 |
Would need to make some changes to the docs repo too, and probably create a new subsection in make rst, but I can do it myself later. |
Another diff needed in this repo: diff --git a/.github/workflows/static_checks.yml b/.github/workflows/static_checks.yml
index 2d4736e1dd..bf3ee49315 100644
--- a/.github/workflows/static_checks.yml
+++ b/.github/workflows/static_checks.yml
@@ -71,11 +71,11 @@ jobs:
- name: Class reference schema checks
run: |
- xmllint --noout --schema doc/class.xsd doc/classes/*.xml modules/*/doc_classes/*.xml
+ xmllint --noout --schema doc/class.xsd doc/classes/*.xml modules/*/doc_classes/*.xml platform/*/doc_classes/*.xml
- name: Documentation checks
run: |
- doc/tools/make_rst.py --dry-run --color doc/classes modules
+ doc/tools/make_rst.py --dry-run --color doc/classes modules platforms
- name: Style checks via clang-format (clang_format.sh)
run: | |
Done.
I guess all editor related classes probably should be in the own subsection. |
Thanks! |
Ensures we can pick up changes introduced in godotengine/godot#76251
Follow up to #74644, moves platform specific XML to the platform sub-folders.