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

Eliminate some unnecessary nesting in the reference docs #2899

Merged
merged 1 commit into from
Feb 25, 2025
Merged

Eliminate some unnecessary nesting in the reference docs #2899

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
8 changes: 1 addition & 7 deletions modal_docs/gen_reference_docs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,20 +76,14 @@ def top_level_filter(module, name):

base_title_level = "#"
forced_module_docs = [
("modal.Function", "modal.functions"),
("modal.Secret", "modal.secret"),
("modal.Dict", "modal.dict"),
("modal.Queue", "modal.queue"),
("modal.call_graph", "modal.call_graph"),
("modal.gpu", "modal.gpu"),
("modal.runner", "modal.runner"),
("modal.Sandbox", "modal.sandbox"),
("modal.ContainerProcess", "modal.container_process"),
("modal.io_streams", "modal.io_streams"),
("modal.FileIO", "modal.file_io"),
]
# These aren't defined in `modal`, but should still be documented as top-level entries.
forced_members = {"web_endpoint", "asgi_app", "method", "wsgi_app", "forward"}
forced_members: set[str] = set()
# These are excluded from the sidebar, typically to 'soft release' some documentation.
sidebar_excluded: set[str] = set()

Expand Down
Loading