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.

Sign up for GitHub

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

Jump to bottom

Adjust make_rst.py for GDScript documentation #98533

Merged
merged 1 commit into from
Dec 2, 2024
Merged

Adjust make_rst.py for GDScript documentation #98533

merged 1 commit into from
Dec 2, 2024

Conversation

dalexeev
Copy link
Member 

# Extract XML files.
godot --doctool --gdscript-docs path/to/project
# XML to RST.
doc/tools/make_rst.py --output docs-rst-folder docs-xml-folder
# RST to HTML.
make html

Test project: test-make-rst-for-rst.zip

@dalexeev dalexeev added this to the 4.4 milestone Oct 25, 2024
@dalexeev dalexeev requested review from a team as code owners October 25, 2024 19:41
dalexeev
dalexeev commented Oct 25, 2024
View reviewed changes
doc/tools/make_rst.py
@@ -2576,6 +2576,13 @@ def format_table(f: TextIO, data: List[Tuple[Optional[str], ...]], remove_empty_
f.write("\n")


def sanitize_class_name(dirty_name: str, is_file_name = False) -> str:
if is_file_name:
return dirty_name.lower().replace('"', "").replace("/", "--")
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Borrowed from here:

godot/editor/doc_tools.cpp

Line 1612 in 61accf0

String save_file = save_path.path_join(c.name.replace("\"", "").replace("/", "--") + ".xml");

@dalexeev dalexeev force-pushed the adjust-make-rst-for-gds branch from 6403f5f to 45fa83b Compare October 25, 2024 19:47
@dalexeev dalexeev mentioned this pull request Oct 25, 2024
Closed
@dalexeev dalexeev force-pushed the adjust-make-rst-for-gds branch from 45fa83b to e708ce6 Compare October 25, 2024 20:15
adamscott
adamscott approved these changes Nov 5, 2024
View reviewed changes
Copy link
Member

@adamscott adamscott left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems alright.

akien-mga
akien-mga approved these changes Nov 29, 2024
View reviewed changes
Copy link
Member

@akien-mga akien-mga left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Needs rebase.

@dalexeev dalexeev force-pushed the adjust-make-rst-for-gds branch from e708ce6 to ba943e4 Compare November 30, 2024 08:48
@akien-mga akien-mga merged commit 702f567 into godotengine:master Dec 2, 2024
20 checks passed
@akien-mga
Copy link
Member

Thanks!

@dalexeev dalexeev deleted the adjust-make-rst-for-gds branch December 2, 2024 15:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@adamscott adamscott adamscott approved these changes

@akien-mga akien-mga akien-mga approved these changes

Assignees
No one assigned
Labels
bug enhancement topic:buildsystem topic:gdscript
Projects
None yet
Milestone
4.4
Development

Successfully merging this pull request may close these issues.

[Documentation Generation] make_rst.py fails to generate rst files for any gdscript generates xml files.
3 participants
@dalexeev @akien-mga @adamscott