PYDOC-6 [a]: Rebuild official docs using RTD theme #1
Conversation
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
|
Round 2 success.
Resolved now and lesson learned. |
… bar home button to main index (instead of gargantuan toc `contents.html` page).
…] references' brackets.
…r installing/index.rst -- otherwise it will always appear on the global sidebar TOC
…ferences located at `index.html` :)
python-sidebar
commented
Feb 20, 2023
| <div role="navigation" aria-label="{{ _('Page navigation') }}"> | ||
| <ul class="wy-breadcrumbs"> | ||
| {%- block breadcrumbs %} | ||
| <li><a href="{{ pathto('index') }}" class="icon icon-home" aria-label="Home"></a></li> |
There was a problem hiding this comment.
Originally, w/o mod, this said
<a href="{{ pathto(master_doc) }}"
which means the home button always takes you back to the ginormous TOC page (instead of the real "home" we think of at index.html from our beloved Pydocs).
So instead this is now:
<a href="{{ pathto('index') }}"
python-sidebar
commented
Feb 20, 2023
| {# the master_doc variable was renamed to root_doc in Sphinx 4 (master_doc still exists in later Sphinx versions) #} | ||
| {%- set _logo_url = logo_url|default(pathto('_static/' + (logo or ""), 1)) %} | ||
| {%- set _root_doc = root_doc|default('master_doc') %} | ||
| <a href="{{ pathto('index') }}"{% if not theme_logo_only %} class="icon icon-home"{% endif %}> |
There was a problem hiding this comment.
See comment above.
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.
PYDOC-6 Ticket: https://trello.com/c/StGB3VAw/6-pydoc-6-change-theme-to-rtd-sphinx-rebuild-push-to-website
PYDOC-6 PR [a]: this
PYDOC-6 PR [b]: companion PR in the GitHub Pages repo