Skip to content

ARROW-12188: [Docs] Switch to pydata-sphinx-theme for the main sphinx docs #9876

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
Closed
jorisvandenbossche wants to merge 10 commits into from
Closed

ARROW-12188: [Docs] Switch to pydata-sphinx-theme for the main sphinx docs #9876

jorisvandenbossche wants to merge 10 commits into from

Conversation

@jorisvandenbossche
Copy link
Member

@jorisvandenbossche jorisvandenbossche commented Apr 2, 2021

No description provided.

@github-actions
Copy link

github-actions bot commented Apr 2, 2021

https://issues.apache.org/jira/browse/ARROW-12188

wjones127
wjones127 reviewed Apr 3, 2021
View reviewed changes
Copy link
Member

@wjones127 wjones127 left a comment

Choose a reason for hiding this comment

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

I poked around a bit and the new theme works quite well.

I think I prefer how the sidebar in the option 3 from the JIRA worked over what's implemented here in two respects:

  1. It collapsed the nav options by default, making it quick to scan through the top-level sections.
  2. You could expand a section in the navbar without triggering a page navigation.

@jorisvandenbossche
Copy link
Member Author

jorisvandenbossche commented Apr 6, 2021

I think I prefer how the sidebar in the option 3 from the JIRA worked over what's implemented here in two respects:

@wjones127 thanks for testing!
Maybe one thing I should have noted: this PR requires the master version of the theme, and then the 2 items (the captions + ability to expand sections without triggering a page navigation) should work as they worked in the option 3 preview of JIRA.

@jorisvandenbossche jorisvandenbossche force-pushed the ARROW-12188-docs-theme branch 2 times, most recently from 847c7a3 to 636c41d Compare April 6, 2021 17:38
@jorisvandenbossche
Copy link
Member Author

jorisvandenbossche commented Apr 13, 2021

@github-actions crossbow submit test-ubuntu-18.04-docs

@github-actions
Copy link

github-actions bot commented Apr 13, 2021

Revision: b49803a0061ce599007b05832662a3cd2e534342

Submitted crossbow builds: ursacomputing/crossbow @ actions-317

Task Status
test-ubuntu-18.04-docs Azure

@jorisvandenbossche
Copy link
Member Author

jorisvandenbossche commented Apr 14, 2021

@github-actions crossbow submit test-ubuntu-18.04-docs

@jorisvandenbossche
Copy link
Member Author

jorisvandenbossche commented Apr 15, 2021

@github-actions crossbow submit test-ubuntu-20.04-docs

@jorisvandenbossche
Copy link
Member Author

jorisvandenbossche commented Apr 15, 2021

@github-actions crossbow submit test-ubuntu-20.10-docs

@github-actions
Copy link

github-actions bot commented Apr 15, 2021

Revision: ed430a9

Submitted crossbow builds: ursacomputing/crossbow @ actions-322

Task Status
test-ubuntu-20.10-docs Azure

@jorisvandenbossche
Copy link
Member Author

jorisvandenbossche commented Apr 15, 2021

As in #9933 (comment), the doc build is failing for Java (even before building the sphinx docs), so is not actually useful to check at the moment.

@jorisvandenbossche jorisvandenbossche deleted the ARROW-12188-docs-theme branch April 15, 2021 14:20
@asfimport asfimport mentioned this pull request Nov 23, 2022
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@wjones127 wjones127 wjones127 left review comments

@lidavidm lidavidm lidavidm approved these changes

Assignees

No one assigned

Labels

Component: Python

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@jorisvandenbossche @lidavidm @wjones127