Add breadcrumbs to all sphinx pages #20
Merged
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.
Closes #16
Summary:
html_theme_option
"show_breadcrumbs": True
html_theme_option
"additional_breadcrumbs": [("Link text", "href")]
Issues:
index.rst
page. As a result, I'm relying on using thehtml_title
as set inconf.py
. The problem is that this isn't necessarily the same as the title of theindex.rst
page.Todo:
Assuming the approach is accepted, the docs need to be updated to describe how to enable this functionality and how to correctly set the
html_title
as described above.Screenshots
Docs without any changes to conf.py:
With breadcrumbs added:
"show_breadcrumbs": True,
With additional root element linking to pyansys:
"additional_breadcrumbs": [("PyAnsys Home", "https://docs.pyansys.com/")],