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-35404: [Docs] Fix logo url and temporarily pin sphinx to 5.x to #35405

Merged

Conversation

jorisvandenbossche
Copy link
Member

@jorisvandenbossche jorisvandenbossche commented May 3, 2023

See #35403 about requiring some fixes on our side to support sphinx 6. Until then, let's pin sphinx to <6.

@github-actions
Copy link

github-actions bot commented May 3, 2023

@github-actions
Copy link

github-actions bot commented May 3, 2023

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

@jorisvandenbossche
Copy link
Member Author

@github-actions crossbow submit preview-docs

@github-actions github-actions bot added the awaiting committer review Awaiting committer review label May 3, 2023
@github-actions
Copy link

github-actions bot commented May 3, 2023

Revision: 7f2d7b4

Submitted crossbow builds: ursacomputing/crossbow @ actions-f17fd805e0

Task Status
preview-docs Github Actions

@jorisvandenbossche
Copy link
Member Author

@github-actions crossbow submit preview-docs

@github-actions
Copy link

github-actions bot commented May 3, 2023

Revision: 750b3cb

Submitted crossbow builds: ursacomputing/crossbow @ actions-0a103adb20

Task Status
preview-docs Github Actions

@jorisvandenbossche jorisvandenbossche changed the title GH-35404: Temporarily pin sphinx to 5.x to fix the doc build GH-35404: Fix the doc build: fix logo url and temporarily pin sphinx to 5.x to May 3, 2023
@jorisvandenbossche
Copy link
Member Author

This seems to have worked: http://crossbow.voltrondata.com/pr_docs/35405/

@kou kou changed the title GH-35404: Fix the doc build: fix logo url and temporarily pin sphinx to 5.x to GH-35404: [Docs] Fix logo url and temporarily pin sphinx to 5.x to May 3, 2023
@@ -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.

@github-actions github-actions bot added awaiting changes Awaiting changes and removed awaiting committer review Awaiting committer review labels May 3, 2023
@jorisvandenbossche jorisvandenbossche merged commit 57c956e into apache:main May 4, 2023
@jorisvandenbossche jorisvandenbossche deleted the gh-35404-pin-sphinx branch May 4, 2023 07:22
@westonpace
Copy link
Member

Ah, thanks for catching this. I thought I tested the logo_url fix but maybe I didn't test with the same sphinx version 😦

@ursabot
Copy link

ursabot commented May 4, 2023

Benchmark runs are scheduled for baseline = b9cc5df and contender = 57c956e. 57c956e is a master commit associated with this PR. Results will be available as each benchmark for each run completes.
Conbench compare runs links:
[Finished ⬇️0.0% ⬆️0.0%] ec2-t3-xlarge-us-east-2
[Finished ⬇️1.68% ⬆️0.06%] test-mac-arm
[Finished ⬇️0.0% ⬆️0.0%] ursa-i9-9960x
[Finished ⬇️0.39% ⬆️0.0%] ursa-thinkcentre-m75q
Buildkite builds:
[Finished] 57c956e1 ec2-t3-xlarge-us-east-2
[Finished] 57c956e1 test-mac-arm
[Finished] 57c956e1 ursa-i9-9960x
[Finished] 57c956e1 ursa-thinkcentre-m75q
[Finished] b9cc5df8 ec2-t3-xlarge-us-east-2
[Finished] b9cc5df8 test-mac-arm
[Finished] b9cc5df8 ursa-i9-9960x
[Finished] b9cc5df8 ursa-thinkcentre-m75q
Supported benchmarks:
ec2-t3-xlarge-us-east-2: Supported benchmark langs: Python, R. Runs only benchmarks with cloud = True
test-mac-arm: Supported benchmark langs: C++, Python, R
ursa-i9-9960x: Supported benchmark langs: Python, R, JavaScript
ursa-thinkcentre-m75q: Supported benchmark langs: C++, Java

@ursabot
Copy link

ursabot commented May 4, 2023

['Python', 'R'] benchmarks have high level of regressions.
test-mac-arm

raulcd pushed a commit that referenced this pull request May 5, 2023
…35405)

See #35403 about requiring some fixes on our side to support sphinx 6. Until then, let's pin sphinx to <6.

* Closes: #35404
* Closes: #35406

Authored-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
Signed-off-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
liujiacheng777 pushed a commit to LoongArch-Python/arrow that referenced this pull request May 11, 2023
… to (apache#35405)

See apache#35403 about requiring some fixes on our side to support sphinx 6. Until then, let's pin sphinx to <6.

* Closes: apache#35404
* Closes: apache#35406

Authored-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
Signed-off-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
ArgusLi pushed a commit to Bit-Quill/arrow that referenced this pull request May 15, 2023
… to (apache#35405)

See apache#35403 about requiring some fixes on our side to support sphinx 6. Until then, let's pin sphinx to <6.

* Closes: apache#35404
* Closes: apache#35406

Authored-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
Signed-off-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
rtpsw pushed a commit to rtpsw/arrow that referenced this pull request May 16, 2023
… to (apache#35405)

See apache#35403 about requiring some fixes on our side to support sphinx 6. Until then, let's pin sphinx to <6.

* Closes: apache#35404
* Closes: apache#35406

Authored-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
Signed-off-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
raulcd pushed a commit that referenced this pull request May 30, 2023
…35405)

See #35403 about requiring some fixes on our side to support sphinx 6. Until then, let's pin sphinx to <6.

* Closes: #35404
* Closes: #35406

Authored-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
Signed-off-by: Joris Van den Bossche <jorisvandenbossche@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.

[Website][Docs] Missing logo on Arrow docs page [Docs] Temporarily pin sphinx to 5.x for the doc build
5 participants