Use sphinx todo for currently empty sections of docs#654
Merged
Conversation
aaronayres35
changed the title
rahulporuri
approved these changes
Apr 21, 2021
Contributor
rahulporuri
left a comment
rahulporuri
left a comment
There was a problem hiding this comment.
LGTM. I don't think we need an issue right now but if we don't address all of the TODO items before the upcoming release (which is possible), we will want to create one.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds various
.. todo::statements across the docs to prevent empty sections from being shown in the built docs.Note this generates additional sphinx warnings which I am unsure how to resolve currentlyThese were warnings of the form "Unexpected Section Title" and commenting out the section titles inside the todo blocks got rid of them