-
Notifications
You must be signed in to change notification settings - Fork 200
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
Remove deprecated functionality #1537
Remove deprecated functionality #1537
Conversation
/merge |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The approach to the docs looks solid, good find. Couple of small fixes.
# exclude_patterns list | ||
if not os.path.exists(breathe_projects["librmm"] + "/deprecated.xml"): | ||
exclude_patterns.append("librmm_docs/deprecated.rst") | ||
suppress_warnings.append("toc.excluded") |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What is this for? I'd guess when you exclude things it generates an extra file and then it warns about that file not being included anywhere, or something like that?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Because deprecated
is listed in the toc in the main RST file. This lets us leave it there even though the deprecated.rst file is excluded. Without this suppression you get a warning that an excluded file is in the toc.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I didn't have a better way to conditionally remove it from the toc.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah OK I see. Yeah that seems fine then.
Co-authored-by: Vyas Ramasubramani <[email protected]>
Co-authored-by: Vyas Ramasubramani <[email protected]>
/merge |
Description
Closes #1536
Checklist