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

[CI][Docs] Nightly tests for ubuntu-default-docs is failing due to new sphinx version #35192

Closed
raulcd opened this issue Apr 17, 2023 · 1 comment · Fixed by #35194
Closed

[CI][Docs] Nightly tests for ubuntu-default-docs is failing due to new sphinx version #35192

raulcd opened this issue Apr 17, 2023 · 1 comment · Fixed by #35194
Assignees
@westonpace
Labels
Component: Continuous Integration Component: Documentation Priority: Blocker Marks a blocker for the release Type: bug
Milestone
12.0.0

Comments

@raulcd
Copy link
Member

raulcd commented Apr 17, 2023

Describe the bug, including details regarding any error messages, version, and platform.

The test-ubuntu-default-docs job has been failing with the following error:

Theme error:
An error happened in rendering the page c_glib/index.
Reason: UndefinedError("'logo' is undefined")

This is also happening on the 12.0.0 branch.
As @westonpace pointed me out it seems the last passing docs build used sphinx 5.3. All doc builds since then have been failing with sphinx 6.1.

Component(s)

Continuous Integration, Documentation
@raulcd raulcd added Type: bug Priority: Blocker Marks a blocker for the release labels Apr 17, 2023
@raulcd raulcd added this to the 12.0.0 milestone Apr 17, 2023
@westonpace westonpace self-assigned this Apr 17, 2023
@westonpace
Copy link
Member

Looks like sphinx 6.0.0 requires logo_url instead of logo. I think we are only using logo in one place. I'll try some experiments.

@raulcd raulcd mentioned this issue Apr 17, 2023
Merged
@github-actions github-actions bot mentioned this issue Apr 17, 2023
Merged
raulcd pushed a commit that referenced this issue Apr 18, 2023
@westonpace
GH-35192: [Docs] Switch from logo to logo_url to support sphinx >…
00072f9 
…= 6 (#35194)

### Rationale for this change

Sphinx dropped support for the `logo` property in release 6.  See sphinx-doc/sphinx#11062  Instead we are supposed to use `logo_url` which has been available since release 4.

### What changes are included in this PR?

Change from `logo` to `logo_url`

### Are these changes tested?

There was a CI test that was failing so yes.

### Are there any user-facing changes?

No.  We already required `sphinx >= 4` and since `logo_url` is available in 4 we should not need to update the minimum sphinx version.
* Closes: #35192

Authored-by: Weston Pace <weston.pace@gmail.com>
Signed-off-by: Raúl Cumplido <raulcumplido@gmail.com>
raulcd pushed a commit that referenced this issue Apr 19, 2023
@westonpace @raulcd
GH-35192: [Docs] Switch from logo to logo_url to support sphinx >…
6d944a0 
…= 6 (#35194)

### Rationale for this change

Sphinx dropped support for the `logo` property in release 6.  See sphinx-doc/sphinx#11062  Instead we are supposed to use `logo_url` which has been available since release 4.

### What changes are included in this PR?

Change from `logo` to `logo_url`

### Are these changes tested?

There was a CI test that was failing so yes.

### Are there any user-facing changes?

No.  We already required `sphinx >= 4` and since `logo_url` is available in 4 we should not need to update the minimum sphinx version.
* Closes: #35192

Authored-by: Weston Pace <weston.pace@gmail.com>
Signed-off-by: Raúl Cumplido <raulcumplido@gmail.com>
liujiacheng777 pushed a commit to LoongArch-Python/arrow that referenced this issue May 11, 2023
@westonpace @liujiacheng777
apacheGH-35192: [Docs] Switch from logo to logo_url to support sp…
ba5c3b7 
…hinx >= 6 (apache#35194)

### Rationale for this change

Sphinx dropped support for the `logo` property in release 6.  See sphinx-doc/sphinx#11062  Instead we are supposed to use `logo_url` which has been available since release 4.

### What changes are included in this PR?

Change from `logo` to `logo_url`

### Are these changes tested?

There was a CI test that was failing so yes.

### Are there any user-facing changes?

No.  We already required `sphinx >= 4` and since `logo_url` is available in 4 we should not need to update the minimum sphinx version.
* Closes: apache#35192

Authored-by: Weston Pace <weston.pace@gmail.com>
Signed-off-by: Raúl Cumplido <raulcumplido@gmail.com>
ArgusLi pushed a commit to Bit-Quill/arrow that referenced this issue May 15, 2023
@westonpace @ArgusLi
apacheGH-35192: [Docs] Switch from logo to logo_url to support sp…
14b0605 
…hinx >= 6 (apache#35194)

### Rationale for this change

Sphinx dropped support for the `logo` property in release 6.  See sphinx-doc/sphinx#11062  Instead we are supposed to use `logo_url` which has been available since release 4.

### What changes are included in this PR?

Change from `logo` to `logo_url`

### Are these changes tested?

There was a CI test that was failing so yes.

### Are there any user-facing changes?

No.  We already required `sphinx >= 4` and since `logo_url` is available in 4 we should not need to update the minimum sphinx version.
* Closes: apache#35192

Authored-by: Weston Pace <weston.pace@gmail.com>
Signed-off-by: Raúl Cumplido <raulcumplido@gmail.com>
rtpsw pushed a commit to rtpsw/arrow that referenced this issue May 16, 2023
@westonpace @rtpsw
apacheGH-35192: [Docs] Switch from logo to logo_url to support sp…
13aa039 
…hinx >= 6 (apache#35194)

### Rationale for this change

Sphinx dropped support for the `logo` property in release 6.  See sphinx-doc/sphinx#11062  Instead we are supposed to use `logo_url` which has been available since release 4.

### What changes are included in this PR?

Change from `logo` to `logo_url`

### Are these changes tested?

There was a CI test that was failing so yes.

### Are there any user-facing changes?

No.  We already required `sphinx >= 4` and since `logo_url` is available in 4 we should not need to update the minimum sphinx version.
* Closes: apache#35192

Authored-by: Weston Pace <weston.pace@gmail.com>
Signed-off-by: Raúl Cumplido <raulcumplido@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@westonpace westonpace

Labels
Component: Continuous Integration Component: Documentation Priority: Blocker Marks a blocker for the release Type: bug
Projects
None yet
Milestone
12.0.0
Development

Successfully merging a pull request may close this issue.

GH-35192: [Docs] Switch from logo to logo_url to support sphinx >= 6 westonpace/arrow
2 participants
@raulcd @westonpace