search

executablebooks / sphinx-book-theme

A clean book theme for scientific explanations and documentation with Sphinx
https://sphinx-book-theme.readthedocs.io
BSD 3-Clause "New" or "Revised" License
413 stars 196 forks source link

Allow article header buttons to be excluded #797

Open choldgraf opened 7 months ago

choldgraf commented 7 months ago

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: https://github.com/executablebooks/sphinx-book-theme/issues/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:

https://github.com/executablebooks/sphinx-book-theme/blob/715478527a99ac84e61cb10842708d258b81cd30/src/sphinx_book_theme/theme/sphinx_book_theme/theme.conf#L4

Tasks and updates