Remove extra_navbar from the theme options reference - #995
Open
dchaudhari7177 wants to merge 1 commit into
Open
Conversation
The option does not exist. `theme.conf` has no `extra_navbar`, and the
name appears nowhere in `src/`, so Sphinx rejects it:
WARNING: unsupported theme option 'extra_navbar' given
Its description was stale in a second way too: the cross-reference it
offered, `content-footer:extra-footer`, names no target in the docs, and
what it describes is `extra_footer`, the row directly below it.
Drop the row rather than reinstate the option. The sidebar footer slot it
described no longer exists in the PyData-based layout, so bringing it back
would be a new feature rather than a fix, and leaving a documented option
that only produces a warning is worse than not documenting it.
Closes executablebooks#810.
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
1 participant
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 #810.
The reporter is right that
docs/reference.mdis the only placeextra_navbarappears. Confirmed on currentmain:src/sphinx_book_theme/theme/sphinx_book_theme/theme.confdeclaresextra_footerbut noextra_navbar, which is why Sphinx emitsunsupported theme option 'extra_navbar' givenfor the config in the report.The row was stale in a second way as well: it points at
[](content-footer:extra-footer), and that target does not exist anywhere indocs/either — so the only surviving mention of the option also carried a dangling cross-reference. What the description actually describes ("Extra HTML to add ... footer") isextra_footer, the row immediately below it.Why remove rather than reinstate
The option described extra HTML below the sidebar footer, and that slot does not exist in the current PyData-based layout — the footer is assembled from
footer_content_items(author.html, copyright.html, last-updated.html, extra-footer.html) and the sidebar fromsidebarsintheme.conf. Re-adding it would mean designing a new insertion point, which is a feature decision rather than a fix for this issue. Meanwhile a documented option that can only produce a build warning is worse for users than no entry at all — it is what sent the reporter looking.Happy to open a separate issue for a sidebar-footer slot if you'd want one.
Docs only; no code or template changes.