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

Remove unwanted members from API documentation #85

Merged
merged 3 commits into from
Sep 4, 2024
Merged

Remove unwanted members from API documentation #85

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
04ab043
Remove unwanted members from API documentation
melissawm Aug 15, 2024
dcc1954
Addressing review comments
melissawm Sep 2, 2024
850d870
Merge branch 'main' into remove-members
dgmccart Sep 4, 2024
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
6 changes: 3 additions & 3 deletions mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,16 +104,16 @@ plugins:
enable_inventory: true
show_root_toc_entry: false
show_root_full_path: true
show_root_members_full_path: true
show_root_members_full_path: false # remove acquire. prefix from objects
show_object_full_path: false
show_category_heading: false
show_symbol_type_heading: true
show_symbol_type_toc: false
# Members options
inherited_members: false
members: true
# members: true
melissawm marked this conversation as resolved.
Show resolved Hide resolved
members_order: "alphabetical"
filters: ["!^_", "!dict"] # Remove private members
filters: ["!^_", "!dict", "!setup_", "!gui"] # Remove private members
Copy link
Member

Choose a reason for hiding this comment

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

Should this be "!_setup"?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

My understanding is we wanted to remove the setup_one_streams and setup_two_streams functions - is that not right?

group_by_category: true
show_submodules: false
summary: true
Expand Down