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-39759: [Docs] Update pydata-sphinx-theme to 0.15.x #39879

Conversation

Divyansh200102
Copy link
Contributor

@Divyansh200102 Divyansh200102 commented Feb 1, 2024

Rationale for this change

What changes are included in this PR?

Updated pydata-sphinx-theme to 0.15.x

Are these changes tested?

Yes

Are there any user-facing changes?

No

Copy link

github-actions bot commented Feb 1, 2024

Thanks for opening a pull request!

If this is not a minor PR. Could you open an issue for this pull request on GitHub? https://github.com/apache/arrow/issues/new/choose

Opening GitHub issues ahead of time contributes to the Openness of the Apache Arrow project.

Then could you also rename the pull request title in the following format?

GH-${GITHUB_ISSUE_ID}: [${COMPONENT}] ${SUMMARY}

or

MINOR: [${COMPONENT}] ${SUMMARY}

In the case of PARQUET issues on JIRA the title also supports:

PARQUET-${JIRA_ISSUE_ID}: [${COMPONENT}] ${SUMMARY}

See also:

@Divyansh200102
Copy link
Contributor Author

@github-actions crossbow submit preview-docs

Copy link

github-actions bot commented Feb 1, 2024

Only contributors can submit requests to this bot. Please ask someone from the community for help with getting the first commit in.
The Archery job run can be found at: https://github.com/apache/arrow/actions/runs/7741370606

@kou kou changed the title MINOR: [DOCS] Update pydata-sphinx-theme to 0.15.x MINOR: [Docs] Update pydata-sphinx-theme to 0.15.x Feb 1, 2024
@kou
Copy link
Member

kou commented Feb 1, 2024

This is not a MINOR change: https://github.com/apache/arrow/blob/main/CONTRIBUTING.md#Minor-Fixes

Could you use GH-39759 instead?

@kou
Copy link
Member

kou commented Feb 1, 2024

I think that we need to do like #39658 .

@Divyansh200102 Divyansh200102 changed the title MINOR: [Docs] Update pydata-sphinx-theme to 0.15.x GH-39759: [Docs] Update pydata-sphinx-theme to 0.15.x Feb 1, 2024
Copy link

github-actions bot commented Feb 1, 2024

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

@kou
Copy link
Member

kou commented Feb 1, 2024

Could you also fill items in our PR template?

@Divyansh200102
Copy link
Contributor Author

I think that we need to do like #39658 .

Got it

Copy link

github-actions bot commented Feb 1, 2024

Revision: 9a5314f

Submitted crossbow builds: ursacomputing/crossbow @ actions-c32f679e0f

Task Status
preview-docs GitHub Actions

Copy link

github-actions bot commented Feb 1, 2024

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

2 similar comments
Copy link

github-actions bot commented Feb 1, 2024

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

Copy link

github-actions bot commented Feb 2, 2024

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

@kou
Copy link
Member

kou commented Feb 2, 2024

@github-actions crossbow submit preview-docs

@@ -5,7 +5,7 @@
breathe
ipython
numpydoc
pydata-sphinx-theme~=0.14
pydata-sphinx-theme~=0.15.2
Copy link
Member

Choose a reason for hiding this comment

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

@jorisvandenbossche @AlenkaF Do we need .2 with ~=?

Copy link
Member

Choose a reason for hiding this comment

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

AFAIK if ~= is added then pip will install the latest 0.15.x version that is higher or equal to 0.15.2. So I think this is fine.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Then why are the checks failing?

Copy link
Member

Choose a reason for hiding this comment

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

I do not think they are connected.
We can still try and change to ==0.15.* to see if it makes a difference.

Copy link
Member

Choose a reason for hiding this comment

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

Or remove the .2 as Kou suggested 😊

Copy link
Member

Choose a reason for hiding this comment

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

It seems that you have too much indent for line 1201-1208.

Anyway, we should do it ( #39879 (comment) ) in a separated PR as @AlenkaF suggested ( #39879 (comment) ).

Could you open an issue for it to work on it as a separated task?

Copy link
Contributor Author

@Divyansh200102 Divyansh200102 Feb 14, 2024

Choose a reason for hiding this comment

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

If you want @kou I can work on the indentation in this pr ?
BTW I think these are the errors coming in the docker-compose.yml file so if I am supposed to open a separate issue should I work on only this part where I made the code changes

  1204:13   error    wrong indentation: expected 8 but found 12  (indentation)
  1206:13   error    wrong indentation: expected 8 but found 12  (indentation)

or on all the errors?

Divyansh@LAPTOP-8JH824JM MINGW64 ~/Documents/GitHub/arrow (Update-pydata-sphinx-theme-to-0.15.x)
$ yamllint docker-compose.yml
docker-compose.yml
  1:61      error    wrong new line character: expected \n  (new-lines)
  56:1      warning  missing document start "---"  (document-start)
  116:5     error    wrong indentation: expected 6 but found 4  (indentation)
  117:7     error    wrong indentation: expected 8 but found 6  (indentation)
  120:9     error    wrong indentation: expected 10 but found 8  (indentation)
  121:11    error    wrong indentation: expected 12 but found 10  (indentation)
  132:5     error    wrong indentation: expected 6 but found 4  (indentation)
  133:7     error    wrong indentation: expected 8 but found 6  (indentation)
  136:5     error    wrong indentation: expected 6 but found 4  (indentation)
  140:5     error    wrong indentation: expected 6 but found 4  (indentation)
  144:5     error    wrong indentation: expected 6 but found 4  (indentation)
  146:7     error    wrong indentation: expected 8 but found 6  (indentation)
  149:7     error    wrong indentation: expected 8 but found 6  (indentation)
  156:5     error    wrong indentation: expected 6 but found 4  (indentation)
  171:5     error    wrong indentation: expected 6 but found 4  (indentation)
  328:81    error    line too long (87 > 80 characters)  (line-length)
  697:81    error    line too long (81 > 80 characters)  (line-length)
  1102:81   error    line too long (110 > 80 characters)  (line-length)
  1113:81   error    line too long (111 > 80 characters)  (line-length)
  1122:81   error    line too long (100 > 80 characters)  (line-length)
  1139:81   error    line too long (82 > 80 characters)  (line-length)
  1153:81   error    line too long (89 > 80 characters)  (line-length)
  1204:13   error    wrong indentation: expected 8 but found 12  (indentation)
  1206:13   error    wrong indentation: expected 8 but found 12  (indentation)
  1354:8    error    too many spaces inside brackets  (brackets)
  1356:81   error    line too long (93 > 80 characters)  (line-length)
  1358:77   error    too many spaces inside brackets  (brackets)
  1439:81   error    line too long (81 > 80 characters)  (line-length)
  1460:81   error    line too long (96 > 80 characters)  (line-length)
  1515:81   error    line too long (96 > 80 characters)  (line-length)
  1541:81   error    line too long (108 > 80 characters)  (line-length)
  1542:81   error    line too long (119 > 80 characters)  (line-length)
  1912:81   error    line too long (90 > 80 characters)  (line-length)
  1914:81   error    line too long (93 > 80 characters)  (line-length)
  1934:81   error    line too long (88 > 80 characters)  (line-length)
  1939:81   error    line too long (85 > 80 characters)  (line-length)
  1962:81   error    line too long (88 > 80 characters)  (line-length)
  1967:81   error    line too long (82 > 80 characters)  (line-length)
  1991:81   error    line too long (88 > 80 characters)  (line-length)

(myenv) 

Copy link
Contributor Author

Choose a reason for hiding this comment

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

If you want @kou I can work on the indentation in this pr ?
BTW I think these are the errors coming in the docker-compose.yml file so if I am supposed to open a separate issue should I work on only this part where I made the code changes

@kou could you please take a look at the quoted text

Copy link
Member

Choose a reason for hiding this comment

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

Please don't do it in this PR. If you want to work on it, please open a new PR for it. It's not related to this PR.

BTW, here is an yamllint output on my environment:

$ yamllint docker-compose.yml
docker-compose.yml
  1:1       warning  missing document start "---"  (document-start)

It seems that you broke docker-compose.yml on your environment.

Copy link
Contributor Author

@Divyansh200102 Divyansh200102 Feb 19, 2024

Choose a reason for hiding this comment

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

So is this PR good to merge?Also is there a way to fix my docker-compose.yml I tried recloning the whole project but still the same errors are coming

Copy link

github-actions bot commented Feb 2, 2024

Revision: 6587af4

Submitted crossbow builds: ursacomputing/crossbow @ actions-85368391e7

Task Status
preview-docs GitHub Actions

@github-actions github-actions bot added awaiting changes Awaiting changes awaiting change review Awaiting change review and removed awaiting review Awaiting review awaiting changes Awaiting changes labels Feb 2, 2024
@kou
Copy link
Member

kou commented Feb 2, 2024

@github-actions crossbow submit preview-docs

Copy link

github-actions bot commented Feb 2, 2024

Revision: 9f0c727

Submitted crossbow builds: ursacomputing/crossbow @ actions-ea146315be

Task Status
preview-docs GitHub Actions

@kou
Copy link
Member

kou commented Feb 4, 2024

@github-actions crossbow submit preview-docs

Copy link

github-actions bot commented Feb 4, 2024

Revision: 1020946

Submitted crossbow builds: ursacomputing/crossbow @ actions-37f7ce3b94

Task Status
preview-docs GitHub Actions

@github-actions github-actions bot added awaiting change review Awaiting change review and removed awaiting changes Awaiting changes labels Feb 21, 2024
@jorisvandenbossche
Copy link
Member

Some quick notes from looking at the preview:

  • The dark/light theme switcher icon is gone?
  • The left sidebar doesn't correctly remember the state if you scrolled it down and clicked on a certain element. This is probably a bug in the theme we should report upstream

@Divyansh200102
Copy link
Contributor Author

@kou Are there any more changes needed in this pr?

@kou
Copy link
Member

kou commented Feb 24, 2024

Could you check #39879 (comment) ?

@Divyansh200102
Copy link
Contributor Author

Divyansh200102 commented Feb 25, 2024

Could you check #39879 (comment) ?

Could you please tell how do I proceed to solve the issues mentioned in #39879 (comment) @kou

@kou
Copy link
Member

kou commented Feb 25, 2024

Sure:

  1. Check whether each item is reproducible
  2. If it's reproducible, look into whether it's an upstream (pydata-sphonx-theme) problem or not
  3. If it's an upstream problem, report it to upstream
  4. If it's not an upstream problem, adjust our configuration for pydata-sphinx-theme 0.15.2

@jorisvandenbossche
Copy link
Member

@Divyansh200102 would you have time to rebase this PR? In the meantime pydata-sphinx-theme 0.15.3 was released, so it would be good to test it with the latest version

@Divyansh200102
Copy link
Contributor Author

Divyansh200102 commented Jun 7, 2024 via email

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] Update pydata-sphinx-theme to 0.15.x
4 participants