Remove deprecated functionality#1537
Conversation
harrism
added
breaking
|
/merge |
vyasr
left a comment
vyasr
left a comment
There was a problem hiding this comment.
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.
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.
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.
I didn't have a better way to conditionally remove it from the toc.
There was a problem hiding this comment.
Ah OK I see. Yeah that seems fine then.
Co-authored-by: Vyas Ramasubramani <vyas.ramasubramani@gmail.com>
Co-authored-by: Vyas Ramasubramani <vyas.ramasubramani@gmail.com>
|
/merge |
4 participants
Description
Closes #1536
Checklist