Skip to content

Fix: Auxiliary projects lost the search box #726

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
amotl merged 1 commit into from
Apr 3, 2026
Merged

Fix: Auxiliary projects lost the search box #726

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion CHANGES.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ CHANGES

Unreleased
----------

- Fix: Auxiliary projects lost the search box

2026/02/22 0.50.2
-----------------
Expand Down
16 changes: 7 additions & 9 deletions src/crate/theme/rtd/sidebartoc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,6 @@ def _get_toctree(maxdepth=-1, titles_only=True, collapse=False):
parts = ['<ul class="toctree nav nav-list">']
builder = _NavBuilder(parts, project, master_path, _get_toctree)


# Special project used standalone
if project == 'SQL 99':
current_class = ' class="current"' if pagename == master_doc else ''
Expand All @@ -116,6 +115,13 @@ def _get_toctree(maxdepth=-1, titles_only=True, collapse=False):
parts.append('</li>')
return ''.join(parts)

# Start CrateDB docs TOC with a Search box
parts.append('<li>')
parts.append('<div class="search-link">')
parts.append('<div id="docsearch" style="min-height: 36px; margin-bottom: 20px;"></div>')
parts.append('</div>')
parts.append('</li>')

# Driver projects use a standalone primary navigation
if project in ['CrateDB JDBC', 'CrateDB Npgsql', 'CrateDB DBAL', 'CrateDB PDO', 'CrateDB Python', 'SQLAlchemy Dialect']:
current_class = ' class="current"' if pagename == master_doc else ''
Expand All @@ -126,14 +132,6 @@ def _get_toctree(maxdepth=-1, titles_only=True, collapse=False):
parts.append('<li class="navleft-item border-top"><a href="https://cratedb.com/docs/guide/connect/">All database drivers</a></li>')
return ''.join(parts)


# Start CrateDB docs TOC with a Search box
parts.append('<li>')
parts.append('<div class="search-link">')
parts.append('<div id="docsearch" style="min-height: 36px; margin-bottom: 20px;"></div>')
parts.append('</div>')
parts.append('</li>')

# Add Guide's toctree entries (Overview, Getting Started, captions, etc.)
if project == 'CrateDB: Guide':
toctree_html = _get_toctree()
Expand Down