Skip to content

Commit a4acec3

Browse files
authored
fix: improve document ui (#18157)
## Which issue does this PR close? <!-- We generally require a GitHub issue to be filed for all bug fixes and enhancements and this helps us generate change logs for our releases. You can link an issue to this PR using the GitHub syntax. For example `Closes #123` indicates that this PR will close issue #123. --> - Closes #17913 . ## Rationale for this change <!-- Why are you proposing this change? If this is already explained clearly in the issue then this section is not needed. Explaining clearly why changes are proposed helps reviewers understand your changes and offer better suggestions for fixes. --> - Improve SQL code block rendering by upgrading `pydata-sphinx-theme` - fix sidebar layout ## What changes are included in this PR? <!-- There is no need to duplicate the description in the issue here but it is sometimes worth providing a summary of the individual changes in this PR. --> ## Are these changes tested? <!-- We typically require tests for all PRs in order to: 1. Prevent the code from being accidentally broken by subsequent changes 4. Serve as another way to document the expected behavior of the code If tests are not included in your PR, please explain why (for example, are they covered by existing tests)? --> yes ## Are there any user-facing changes? documentation ui <!-- If there are user-facing changes then we may require documentation to be updated before approving the PR. --> <!-- If there are any breaking changes to public APIs, please add the `api change` label. -->
1 parent b1deb1f commit a4acec3

File tree

2 files changed

+15
-16
lines changed

2 files changed

+15
-16
lines changed

docs/requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
sphinx==8.2.3
1919
sphinx-reredirects==1.0.0
20-
pydata-sphinx-theme==0.8.0
20+
pydata-sphinx-theme==0.16.1
2121
myst-parser==4.0.1
2222
maturin==1.9.6
2323
jinja2==3.1.6
Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,20 @@
1-
2-
3-
<form class="bd-search d-flex align-items-center" action="{{ pathto('search') }}" method="get">
4-
<i class="icon fas fa-search"></i>
5-
<input type="search" class="form-control" name="q" id="search-input" placeholder="{{ theme_search_bar_text }}" aria-label="{{ theme_search_bar_text }}" autocomplete="off" >
6-
</form>
7-
1+
<p>
2+
<a href="{{ pathto(master_doc) }}">
3+
<img src="{{ pathto('_static/images/2x_bgwhite_original.png', 1) }}" class="logo" alt="logo">
4+
</a>
5+
</p>
6+
<p>
7+
<form class="bd-search d-flex align-items-center" action="{{ pathto('search') }}" method="get">
8+
<input type="search" class="form-control" name="q" id="search-input" placeholder="{{ theme_search_bar_text }}" aria-label="{{ theme_search_bar_text }}" autocomplete="off" >
9+
</form>
10+
</p>
811
<nav class="bd-links" id="bd-docs-nav" aria-label="Main navigation">
12+
913
<div class="bd-toc-item active">
1014
{% if "python/api" in pagename or "python/generated" in pagename %}
11-
{{ generate_nav_html("sidebar", startdepth=0, maxdepth=3, collapse=False, includehidden=True, titles_only=True) }}
15+
{{ generate_toctree_html("sidebar", startdepth=0, maxdepth=3, collapse=False, includehidden=True, titles_only=True) }}
1216
{% else %}
13-
{{ generate_nav_html("sidebar", startdepth=0, maxdepth=4, collapse=False, includehidden=True, titles_only=True) }}
17+
{{ generate_toctree_html("sidebar", startdepth=0, maxdepth=4, collapse=False, includehidden=True, titles_only=True) }}
1418
{% endif %}
1519
</div>
16-
17-
<a class="navbar-brand" href="{{ pathto(master_doc) }}">
18-
<img src="{{ pathto('_static/images/2x_bgwhite_original.png', 1) }}" class="logo" alt="logo">
19-
</a>
20-
</nav>
21-
20+
</nav>

0 commit comments

Comments
 (0)