Skip to content

feat(docs): enable navbar #18324

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Oct 31, 2025
+33 −25
Merged

feat(docs): enable navbar #18324

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ab28c3c
feat(docs): enable navbar
foskey51 Oct 28, 2025
85c6651
feat: remove default navbar links
foskey51 Oct 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 27 additions & 10 deletions docs/source/_static/theme_overrides.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@
--pst-color-h2: var(--color-text-base);
/* Use softer blue from bootstrap's default info color */
--pst-color-info: 23, 162, 184;
--pst-header-height: 0px;
}

code {
Expand All @@ -40,16 +39,34 @@ code {
text-align: center;
}

/* Limit both light and dark mode logos in the navbar */
.logo__image {
height: 32px;
width: auto;
max-height: 2.5rem;
}

/* Display appropriate logo for dark and light mode */
.light-logo { display: inline; }
.dark-logo { display: none; }

@media (prefers-color-scheme: dark) {
.light-logo { display: none; }
.dark-logo {
display: inline;
background-color: transparent !important;
}
.light-logo {
display: inline;
}

.dark-logo {
display: none;
}

html[data-theme="dark"] .light-logo {
display: none;
}

html[data-theme="dark"] .dark-logo {
display: inline;
background-color: transparent !important;
}

/* Align search bar & theme switch right */
.navbar-header-items__end {
margin-left: auto;
}

/* Ensure the logo is properly displayed */
Expand Down
11 changes: 0 additions & 11 deletions docs/source/_templates/docs-sidebar.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,3 @@
<p>
<a href="{{ pathto(master_doc) }}">
<img src="{{ pathto('_static/images/original.svg', 1) }}" class="logo light-logo" alt="logo">
<img src="{{ pathto('_static/images/original_dark.svg', 1) }}" class="logo dark-logo" alt="logo">
</a>
</p>
<p>
<form class="bd-search d-flex align-items-center" action="{{ pathto('search') }}" method="get">
<input type="search" class="form-control" name="q" id="search-input" placeholder="{{ theme_search_bar_text }}" aria-label="{{ theme_search_bar_text }}" autocomplete="off" >
</form>
</p>
<nav class="bd-links" id="bd-docs-nav" aria-label="Main navigation">

<div class="bd-toc-item active">
Expand Down
4 changes: 0 additions & 4 deletions docs/source/_templates/layout.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
{% extends "pydata_sphinx_theme/layout.html" %}

{# Silence the navbar #}
{% block docs_navbar %}
{% endblock %}

<!--
Custom footer
-->
Expand Down
6 changes: 6 additions & 0 deletions docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,13 @@
html_theme = "pydata_sphinx_theme"

html_theme_options = {
"logo": {
"image_light": "_static/images/original.svg",
"image_dark": "_static/images/original_dark.svg",
},
"use_edit_page_button": True,
"navbar_center": [],
"navbar_end": ["theme-switcher"],
}

html_context = {
Expand Down