Fix toctree warnings and render toctree in the HTML sidebar #20
Conversation
This file contains 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
This commit fixes a warning about the library API document not being included in the document, and also fixes the API sidebar rendering. These two issues are connected because the Sphinx html theme uses the `:toctree:` directive to create the sidebar. References: * Exhale, link to generated documentation API: https://exhale.readthedocs.io/en/latest/usage.html#make-your-documentation-link-to-the-generated-api * Sphinx rtd theme, table of content options: https://sphinx-rtd-theme.readthedocs.io/en/stable/configuring.html#table-of-contents-options Signed-off-by: Abrar Rahman Protyasha <[email protected]>
aprotyas
commented
Jul 23, 2021
This change allows us to relax the assumption that every package contains a README file. A possible TODO could be to add configuration options to enable something like this. Signed-off-by: Abrar Rahman Protyasha <[email protected]>
wjwwood
approved these changes
Jul 23, 2021
|
@wjwwood can you merge the PR? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 fixes a warning about the library API document not being included in the document, and also fixes the sidebar rendering (table of content shows up in the sidebar correctly).
These two issues are connected because the Sphinx html theme uses the
:toctree:directive to create the sidebar.References:
Signed-off-by: Abrar Rahman Protyasha [email protected]