Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow article header buttons to be excluded #797

Open
1 task
choldgraf opened this issue Dec 18, 2023 · 0 comments
Open
1 task

Allow article header buttons to be excluded #797

choldgraf opened this issue Dec 18, 2023 · 0 comments
Labels
enhancement New feature or request

Comments

@choldgraf
Copy link
Member

choldgraf commented Dec 18, 2023

Context

This theme populates the buttons in the "article header" via the template below:

https://github.com/executablebooks/sphinx-book-theme/blob/master/src/sphinx_book_theme/theme/sphinx_book_theme/components/article-header-buttons.html

Several buttons are hard-coded (for example, the theme switcher, which some people want to remove, ref: #750)

We should make it possible for these buttons to be added/removed rather than hard-coding them.

Proposal

We could use a list of template names similar to what we do with the sidebar templates. The way those work is that the user defines a list of strings that correspond to template names in conf.py and those are used to populate the sidebar:

sidebars = navbar-logo.html, icon-links.html, search-button-field.html, sbt-sidebar-nav.html

Tasks and updates

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant