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

ENH: Improve sidebar secondary config and logic #849

Merged
merged 2 commits into from Jul 30, 2022

Conversation

choldgraf
Copy link
Collaborator

@choldgraf choldgraf commented Jul 28, 2022

This is a quick config change that I wanted to get in before the release so we don't have to deprecate the config structure in the future. It uses periods (.) to naturally "nest" page-level metadata so they behave more like our html_theme_options configuration. This is inspired by how TOML does key nesting.

AKA we go from:

  • This: theme_html_remove_secondary_sidebar:
  • To this: html_theme.sidebar_secondary.remove:

I think this also fixes the bug that @tupui noted where an empty sidebar would still show up.

@choldgraf
Copy link
Collaborator Author

I'm going to merge this in since it was undocumented before, and I think this is clearly a nicer structure. We should get an RC out so folks can use this! I hope that's OK

@choldgraf choldgraf changed the title Use nested headers for page config ENH: Improve sidebar secondary config and logic Jul 30, 2022
@choldgraf choldgraf merged commit f57ca0d into pydata:main Jul 30, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant