Skip to content
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

Merged
merged 1 commit into from
Apr 20, 2023

Conversation

bruvzg
Copy link
Member

@bruvzg bruvzg commented Apr 19, 2023

Follow up to #74644, moves platform specific XML to the platform sub-folders.

@akien-mga
Copy link
Member

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

@YuriSizov
Copy link
Contributor

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.

@akien-mga
Copy link
Member

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: |

@bruvzg
Copy link
Member Author

bruvzg commented Apr 20, 2023

Another diff needed in this repo

Done.

Would need to make some changes to the docs repo too, probably create a new subsection in make rst

I guess all editor related classes probably should be in the own subsection.

@akien-mga akien-mga merged commit 2b20a70 into godotengine:master Apr 20, 2023
@akien-mga
Copy link
Member

Thanks!

@bruvzg bruvzg deleted the docs_platf branch April 24, 2023 12:54
YuriSizov added a commit to YuriSizov/godot-docs that referenced this pull request Apr 24, 2023
Ensures we can pick up changes introduced in godotengine/godot#76251
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants