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

Add support for html_show_sphinx. #206

Merged

Conversation

picnixz
Copy link
Member

@picnixz picnixz commented Apr 29, 2023

theme_show_powered_by takes value from html_show_sphinx or html_theme_options['show_powered_by'] when available.

@AA-Turner
Copy link
Member

Would the other way around work? I.e. we change show_powered_by to show_sphinx in layout.html, and then use s_p_b to update the value of show_sphinx?

We should also update the documentation to note that show_sphinx is now preferred.

A

@picnixz
Copy link
Member Author

picnixz commented Apr 30, 2023

Would the other way around work? I.e. we change show_powered_by to show_sphinx in layout.html, and then use s_p_b to update the value of show_sphinx?

I think it should work as well. But is there any possibility for themes inheriting alabaster that they would break ? For instance, they could rely on show_powered_by, meaning that we still need to keep some theme_show_powered_by entry in the context (not really an issue but more a redundancy).

We should also update the documentation to note that show_sphinx is now preferred.

Is there an elegant way to deprecate the usage of such option and, if so, what about the deprecation period ?

``theme_show_powered_by`` takes value from ``html_show_sphinx`` or ``html_theme_options['show_powered_by']`` when available.
@picnixz picnixz force-pushed the feature/205-support-for-show-sphinx branch from 413e37e to d74ada1 Compare April 30, 2023 12:05
@AA-Turner AA-Turner merged commit a28affe into sphinx-doc:0.x Jan 8, 2024
11 checks passed
@picnixz picnixz deleted the feature/205-support-for-show-sphinx branch January 10, 2024 10:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants