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

GH-39640: [Docs] Pin pydata-sphinx-theme to 0.14.1 #39658

Merged
merged 2 commits into from
Jan 17, 2024

Conversation

AlenkaF
Copy link
Member

@AlenkaF AlenkaF commented Jan 17, 2024

The version warning banner in the documentation has the wrong version: it currently uses pydata-sphinx-version instead of Arrow dev version. Testing if the update in upstream fixes this error in version 14.0.1.

Copy link

⚠️ GitHub issue #39640 has been automatically assigned in GitHub to PR creator.

@AlenkaF
Copy link
Member Author

AlenkaF commented Jan 17, 2024

@github-actions crossbow submit preview-docs

Copy link

Revision: b527f93

Submitted crossbow builds: ursacomputing/crossbow @ actions-eb2aae2329

Task Status
preview-docs GitHub Actions

@AlenkaF
Copy link
Member Author

AlenkaF commented Jan 17, 2024

Forgot the versions banner can't be tested with GitHub actions. Will try to set up the docs locally so that the versions can be tested.

@AlenkaF
Copy link
Member Author

AlenkaF commented Jan 17, 2024

Tested locally, version 14.0.1 of pydata-sphinx-theme fixes this issue:

--- TOP ---
Screenshot 2024-01-17 at 16 20 10

--- BOTTOM with package version ---
Screenshot 2024-01-17 at 16 20 14

@AlenkaF AlenkaF marked this pull request as ready for review January 17, 2024 15:22
@AlenkaF
Copy link
Member Author

AlenkaF commented Jan 17, 2024

cc @raulcd

Copy link
Member

@raulcd raulcd left a comment

Choose a reason for hiding this comment

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

Thanks @AlenkaF .

This seems to be the upstream PR that fixes the issue in case someone takes a look in the future: pydata/pydata-sphinx-theme#1446

@github-actions github-actions bot added awaiting merge Awaiting merge and removed awaiting review Awaiting review labels Jan 17, 2024
@AlenkaF AlenkaF merged commit 4a33d2f into apache:main Jan 17, 2024
15 checks passed
@AlenkaF AlenkaF removed the awaiting merge Awaiting merge label Jan 17, 2024
@AlenkaF AlenkaF deleted the test-unpin-pydata-sphinx-theme branch January 17, 2024 15:58
Copy link

After merging your PR, Conbench analyzed the 4 benchmarking runs that have been run so far on merge-commit 4a33d2f.

There were no benchmark performance regressions. 🎉

The full Conbench report has more details.

@jorisvandenbossche
Copy link
Member

Hmm, I would have thought that pydata-sphinx-theme=0.14 would install the latest 0.14.x version (at least that was my intention when adding the pin), but apparently not ...

@jorisvandenbossche
Copy link
Member

OK, for pip requirements, it should probably have been ~= 0.14 or ==0.14.* (for conda I suppose what I did works)

idailylife pushed a commit to idailylife/arrow that referenced this pull request Jan 18, 2024
The version warning banner in the documentation has the wrong version: it currently uses `pydata-sphinx-version` instead of Arrow dev version. Testing if the update in upstream fixes this error in version `14.0.1`.
* Closes: apache#39640

Authored-by: AlenkaF <frim.alenka@gmail.com>
Signed-off-by: AlenkaF <frim.alenka@gmail.com>
clayburn pushed a commit to clayburn/arrow that referenced this pull request Jan 23, 2024
The version warning banner in the documentation has the wrong version: it currently uses `pydata-sphinx-version` instead of Arrow dev version. Testing if the update in upstream fixes this error in version `14.0.1`.
* Closes: apache#39640

Authored-by: AlenkaF <frim.alenka@gmail.com>
Signed-off-by: AlenkaF <frim.alenka@gmail.com>
dgreiss pushed a commit to dgreiss/arrow that referenced this pull request Feb 19, 2024
The version warning banner in the documentation has the wrong version: it currently uses `pydata-sphinx-version` instead of Arrow dev version. Testing if the update in upstream fixes this error in version `14.0.1`.
* Closes: apache#39640

Authored-by: AlenkaF <frim.alenka@gmail.com>
Signed-off-by: AlenkaF <frim.alenka@gmail.com>
raulcd pushed a commit that referenced this pull request Feb 20, 2024
The version warning banner in the documentation has the wrong version: it currently uses `pydata-sphinx-version` instead of Arrow dev version. Testing if the update in upstream fixes this error in version `14.0.1`.
* Closes: #39640

Authored-by: AlenkaF <frim.alenka@gmail.com>
Signed-off-by: AlenkaF <frim.alenka@gmail.com>
zanmato1984 pushed a commit to zanmato1984/arrow that referenced this pull request Feb 28, 2024
The version warning banner in the documentation has the wrong version: it currently uses `pydata-sphinx-version` instead of Arrow dev version. Testing if the update in upstream fixes this error in version `14.0.1`.
* Closes: apache#39640

Authored-by: AlenkaF <frim.alenka@gmail.com>
Signed-off-by: AlenkaF <frim.alenka@gmail.com>
thisisnic pushed a commit to thisisnic/arrow that referenced this pull request Mar 8, 2024
The version warning banner in the documentation has the wrong version: it currently uses `pydata-sphinx-version` instead of Arrow dev version. Testing if the update in upstream fixes this error in version `14.0.1`.
* Closes: apache#39640

Authored-by: AlenkaF <frim.alenka@gmail.com>
Signed-off-by: AlenkaF <frim.alenka@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Docs] The message appearing when selecting dev version of the documentation is wrong
3 participants