Skip to content

Fix API doc generation to include experimental GUI features #1996

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

Merged
merged 1 commit into from
Feb 26, 2024
Merged

Fix API doc generation to include experimental GUI features #1996

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions util/update_quick_index.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,8 @@
'widgets/image.py': ['GUI Widgets', 'gui_widgets.rst'],
'gui/property.py': ['GUI Properties', 'gui_properties.rst'],
'gui/style.py': ['GUI Style', 'gui_style.rst'],
'experimental/password_input.py': ['GUI Experimental Features', 'gui_experimental.rst'],
'experimental/scroll_area.py': ['GUI Experimental Features', 'gui_experimental.rst'],

'events/__init__.py': ['GUI Utility Functions', 'gui_utility.rst'],
'gl/buffer.py': ['OpenGL Buffer', 'open_gl.rst'],
Expand All @@ -108,6 +110,7 @@
'texture_atlas/atlas_array.py',
'texture_atlas/atlas_bindless.py',
'texture_atlas/helpers.py',
'experimental/__init__.py' # Ugly fix for experimental gui features
]

# Module and class members to exclude
Expand Down Expand Up @@ -199,6 +202,7 @@ def process_directory(directory: Path, quick_index_file):
"sprite_list": "arcade",
"text": "arcade",
"gui": "arcade.gui",
"experimental": "arcade.gui.experimental",
"property": "arcade.gui.property",
"widgets": "arcade.gui",
"tilemap": "arcade.tilemap",
Expand Down Expand Up @@ -334,6 +338,7 @@ def main():
process_directory(ROOT / "arcade/gui", text_file)
process_directory(ROOT / "arcade/gui/widgets", text_file)
process_directory(ROOT / "arcade/gui/property", text_file)
process_directory(ROOT / "arcade/gui/experimental", text_file)
process_directory(ROOT / "arcade/tilemap", text_file)

text_file.close()
Expand Down