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.

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

Jump to bottom

GH-35404: [Docs] Fix logo url and temporarily pin sphinx to 5.x to #35405

Merged
merged 2 commits into from
May 4, 2023
Merged

GH-35404: [Docs] Fix logo url and temporarily pin sphinx to 5.x to #35405

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
7f2d7b4
GH-35404: Temporarily pin sphinx to 5.x to fix the doc build
jorisvandenbossche May 3, 2023
750b3cb
fix logo_url path
jorisvandenbossche May 3, 2023
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 ci/conda_env_sphinx.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ ipython
numpydoc
pydata-sphinx-theme==0.8
sphinx-design
sphinx>=4.2
sphinx>=4.2,<6
sphinx-copybutton
# Requirement for doctest-cython
pytest-cython
Expand Down
2 changes: 1 addition & 1 deletion docs/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@ numpydoc
pydata-sphinx-theme==0.8
sphinx-design
sphinx-copybutton
sphinx>=4.2
sphinx>=4.2,<6
pandas
2 changes: 1 addition & 1 deletion docs/source/_templates/docs-sidebar.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@

<a class="navbar-brand" href="{{ pathto(master_doc) }}">
<img src="{{ pathto('_static/' + logo_url, 1) }}" class="logo" alt="logo">
<img src="{{ logo_url|e }}" class="logo" alt="logo">
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this work only with Sphinx 5?
If this works with both of Sphinx 5 and 6, how about removing ,<6 for sphinx from this PR?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This works for both but there are other issue (#35403) that require us to pin to <6 for now.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, @assignUser is spot on. This fixes the logo issue (#35406) regardless of the sphinx version, but we still need to fix the jquery dependency issue for being able to use sphinx 6

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks. I see.

</a>

<div id="version-search-wrapper">
Expand Down