GH-39759: [Docs] Update pydata-sphinx-theme to 0.15.x - #39879

Closed
Divyansh200102 wants to merge 15 commits into
apache:mainfrom
Divyansh200102:Update-pydata-sphinx-theme-to-0.15.x
Closed

GH-39759: [Docs] Update pydata-sphinx-theme to 0.15.x#39879
Divyansh200102 wants to merge 15 commits into
apache:mainfrom
Divyansh200102:Update-pydata-sphinx-theme-to-0.15.x

Conversation

@Divyansh200102

@Divyansh200102Divyansh200102 commented Feb 1, 2024

Copy link
Copy Markdown
Contributor

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

@github-actions

Copy link
Copy Markdown

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
Copy Markdown
ContributorAuthor

@github-actions crossbow submit preview-docs

@github-actions

Copy link
Copy Markdown
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

@koukou changed the title MINOR: [DOCS] Update pydata-sphinx-theme to 0.15.x MINOR: [Docs] Update pydata-sphinx-theme to 0.15.xFeb 1, 2024
@kou

kou commented Feb 1, 2024

Copy link
Copy Markdown
Member

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

Could you use GH-39759 instead?

@kou

kou commented Feb 1, 2024

Copy link
Copy Markdown
Member

I think that we need to do like #39658 .

@Divyansh200102Divyansh200102 changed the title MINOR: [Docs] Update pydata-sphinx-theme to 0.15.xGH-39759: [Docs] Update pydata-sphinx-theme to 0.15.xFeb 1, 2024
@github-actions

Copy link
Copy Markdown

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

@kou

kou commented Feb 1, 2024

Copy link
Copy Markdown
Member

Could you also fill items in our PR template?

@Divyansh200102

Copy link
Copy Markdown
ContributorAuthor

I think that we need to do like #39658 .

Got it

@github-actions

Copy link
Copy Markdown

Revision: 9a5314f43ef5fb314f7c156cf5d91b98bcbc3192

Submitted crossbow builds: ursacomputing/crossbow @ actions-c32f679e0f

TaskStatus
preview-docsGitHub Actions

@github-actions

Copy link
Copy Markdown

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

2 similar comments
@github-actions

Copy link
Copy Markdown

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

@github-actions

Copy link
Copy Markdown

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

@kou

kou commented Feb 2, 2024

Copy link
Copy Markdown
Member

@github-actions crossbow submit preview-docs

Comment threaddocs/requirements.txt Outdated

Copy link
Copy Markdown
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
Copy Markdown
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
Copy Markdown
ContributorAuthor

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
Copy Markdown
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
Copy Markdown
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
Copy Markdown
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?

@Divyansh200102Divyansh200102Feb 14, 2024

Copy link
Copy Markdown
ContributorAuthor

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
Copy Markdown
ContributorAuthor

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
Copy Markdown
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.ymldocker-compose.yml 1:1 warning missing document start "---" (document-start)

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

@Divyansh200102Divyansh200102Feb 19, 2024

Copy link
Copy Markdown
ContributorAuthor

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

@github-actions

Copy link
Copy Markdown

Revision: 6587af478b6fdee398ec840992d70f703bbc431b

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

TaskStatus
preview-docsGitHub Actions

@github-actionsgithub-actionsBot 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

kou commented Feb 2, 2024

Copy link
Copy Markdown
Member

@github-actions crossbow submit preview-docs

@github-actions

Copy link
Copy Markdown

Revision: 9f0c727d9a929e5295c8e6ede49cac4f2f3d1181

Submitted crossbow builds: ursacomputing/crossbow @ actions-ea146315be

TaskStatus
preview-docsGitHub Actions

@kou

kou commented Feb 4, 2024

Copy link
Copy Markdown
Member

@github-actions crossbow submit preview-docs

@github-actions

Copy link
Copy Markdown

Revision: 102094668f7677aac543c17cd8947330203d17ff

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

TaskStatus
preview-docsGitHub Actions

@github-actionsgithub-actionsBot added awaiting change review Awaiting change review and removed awaiting changes Awaiting changes labels Feb 21, 2024
@jorisvandenbossche

Copy link
Copy Markdown
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
Copy Markdown
ContributorAuthor

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

@kou

kou commented Feb 24, 2024

Copy link
Copy Markdown
Member

Could you check #39879 (comment) ?

@Divyansh200102

Divyansh200102 commented Feb 25, 2024

Copy link
Copy Markdown
ContributorAuthor

Could you check #39879 (comment) ?

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

@kou

kou commented Feb 25, 2024

Copy link
Copy Markdown
Member

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
Copy Markdown
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

Divyansh200102 commented Jun 7, 2024 via email

Copy link
Copy Markdown
ContributorAuthor

Sign up for freeto 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.16.x

4 participants

@Divyansh200102@kou@AlenkaF@jorisvandenbossche
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

GH-39759: [Docs] Update pydata-sphinx-theme to 0.15.x - #39879

Closed
Divyansh200102 wants to merge 15 commits into
apache:mainfrom
Divyansh200102:Update-pydata-sphinx-theme-to-0.15.x
Closed

GH-39759: [Docs] Update pydata-sphinx-theme to 0.15.x#39879
Divyansh200102 wants to merge 15 commits into
apache:mainfrom
Divyansh200102:Update-pydata-sphinx-theme-to-0.15.x

Conversation

@Divyansh200102

@Divyansh200102Divyansh200102 commented Feb 1, 2024

Copy link
Copy Markdown
Contributor

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

@github-actions

Copy link
Copy Markdown

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
Copy Markdown
ContributorAuthor

@github-actions crossbow submit preview-docs

@github-actions

Copy link
Copy Markdown
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

@koukou changed the title MINOR: [DOCS] Update pydata-sphinx-theme to 0.15.x MINOR: [Docs] Update pydata-sphinx-theme to 0.15.xFeb 1, 2024
@kou

kou commented Feb 1, 2024

Copy link
Copy Markdown
Member

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

Could you use GH-39759 instead?

@kou

kou commented Feb 1, 2024

Copy link
Copy Markdown
Member

I think that we need to do like #39658 .

@Divyansh200102Divyansh200102 changed the title MINOR: [Docs] Update pydata-sphinx-theme to 0.15.xGH-39759: [Docs] Update pydata-sphinx-theme to 0.15.xFeb 1, 2024
@github-actions

Copy link
Copy Markdown

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

@kou

kou commented Feb 1, 2024

Copy link
Copy Markdown
Member

Could you also fill items in our PR template?

@Divyansh200102

Copy link
Copy Markdown
ContributorAuthor

I think that we need to do like #39658 .

Got it

@github-actions

Copy link
Copy Markdown

Revision: 9a5314f43ef5fb314f7c156cf5d91b98bcbc3192

Submitted crossbow builds: ursacomputing/crossbow @ actions-c32f679e0f

TaskStatus
preview-docsGitHub Actions

@github-actions

Copy link
Copy Markdown

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

2 similar comments
@github-actions

Copy link
Copy Markdown

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

@github-actions

Copy link
Copy Markdown

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

@kou

kou commented Feb 2, 2024

Copy link
Copy Markdown
Member

@github-actions crossbow submit preview-docs

Comment threaddocs/requirements.txt Outdated

Copy link
Copy Markdown
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
Copy Markdown
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
Copy Markdown
ContributorAuthor

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
Copy Markdown
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
Copy Markdown
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
Copy Markdown
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?

@Divyansh200102Divyansh200102Feb 14, 2024

Copy link
Copy Markdown
ContributorAuthor

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
Copy Markdown
ContributorAuthor

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
Copy Markdown
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.ymldocker-compose.yml 1:1 warning missing document start "---" (document-start)

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

@Divyansh200102Divyansh200102Feb 19, 2024

Copy link
Copy Markdown
ContributorAuthor

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

@github-actions

Copy link
Copy Markdown

Revision: 6587af478b6fdee398ec840992d70f703bbc431b

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

TaskStatus
preview-docsGitHub Actions

@github-actionsgithub-actionsBot 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

kou commented Feb 2, 2024

Copy link
Copy Markdown
Member

@github-actions crossbow submit preview-docs

@github-actions

Copy link
Copy Markdown

Revision: 9f0c727d9a929e5295c8e6ede49cac4f2f3d1181

Submitted crossbow builds: ursacomputing/crossbow @ actions-ea146315be

TaskStatus
preview-docsGitHub Actions

@kou

kou commented Feb 4, 2024

Copy link
Copy Markdown
Member

@github-actions crossbow submit preview-docs

@github-actions

Copy link
Copy Markdown

Revision: 102094668f7677aac543c17cd8947330203d17ff

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

TaskStatus
preview-docsGitHub Actions

@github-actionsgithub-actionsBot added awaiting change review Awaiting change review and removed awaiting changes Awaiting changes labels Feb 21, 2024
@jorisvandenbossche

Copy link
Copy Markdown
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
Copy Markdown
ContributorAuthor

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

@kou

kou commented Feb 24, 2024

Copy link
Copy Markdown
Member

Could you check #39879 (comment) ?

@Divyansh200102

Divyansh200102 commented Feb 25, 2024

Copy link
Copy Markdown
ContributorAuthor

Could you check #39879 (comment) ?

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

@kou

kou commented Feb 25, 2024

Copy link
Copy Markdown
Member

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
Copy Markdown
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

Divyansh200102 commented Jun 7, 2024 via email

Copy link
Copy Markdown
ContributorAuthor

Sign up for freeto 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.16.x

4 participants

@Divyansh200102@kou@AlenkaF@jorisvandenbossche
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

GH-39759: [Docs] Update pydata-sphinx-theme to 0.15.x - #39879

Closed
Divyansh200102 wants to merge 15 commits into
apache:mainfrom
Divyansh200102:Update-pydata-sphinx-theme-to-0.15.x
Closed

GH-39759: [Docs] Update pydata-sphinx-theme to 0.15.x#39879
Divyansh200102 wants to merge 15 commits into
apache:mainfrom
Divyansh200102:Update-pydata-sphinx-theme-to-0.15.x

Conversation

@Divyansh200102

@Divyansh200102Divyansh200102 commented Feb 1, 2024

Copy link
Copy Markdown
Contributor

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

@github-actions

Copy link
Copy Markdown

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
Copy Markdown
ContributorAuthor

@github-actions crossbow submit preview-docs

@github-actions

Copy link
Copy Markdown
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

@koukou changed the title MINOR: [DOCS] Update pydata-sphinx-theme to 0.15.x MINOR: [Docs] Update pydata-sphinx-theme to 0.15.xFeb 1, 2024
@kou

kou commented Feb 1, 2024

Copy link
Copy Markdown
Member

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

Could you use GH-39759 instead?

@kou

kou commented Feb 1, 2024

Copy link
Copy Markdown
Member

I think that we need to do like #39658 .

@Divyansh200102Divyansh200102 changed the title MINOR: [Docs] Update pydata-sphinx-theme to 0.15.xGH-39759: [Docs] Update pydata-sphinx-theme to 0.15.xFeb 1, 2024
@github-actions

Copy link
Copy Markdown

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

@kou

kou commented Feb 1, 2024

Copy link
Copy Markdown
Member

Could you also fill items in our PR template?

@Divyansh200102

Copy link
Copy Markdown
ContributorAuthor

I think that we need to do like #39658 .

Got it

@github-actions

Copy link
Copy Markdown

Revision: 9a5314f43ef5fb314f7c156cf5d91b98bcbc3192

Submitted crossbow builds: ursacomputing/crossbow @ actions-c32f679e0f

TaskStatus
preview-docsGitHub Actions

@github-actions

Copy link
Copy Markdown

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

2 similar comments
@github-actions

Copy link
Copy Markdown

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

@github-actions

Copy link
Copy Markdown

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

@kou

kou commented Feb 2, 2024

Copy link
Copy Markdown
Member

@github-actions crossbow submit preview-docs

Comment threaddocs/requirements.txt Outdated

Copy link
Copy Markdown
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
Copy Markdown
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
Copy Markdown
ContributorAuthor

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
Copy Markdown
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
Copy Markdown
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
Copy Markdown
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?

@Divyansh200102Divyansh200102Feb 14, 2024

Copy link
Copy Markdown
ContributorAuthor

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
Copy Markdown
ContributorAuthor

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
Copy Markdown
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.ymldocker-compose.yml 1:1 warning missing document start "---" (document-start)

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

@Divyansh200102Divyansh200102Feb 19, 2024

Copy link
Copy Markdown
ContributorAuthor

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

@github-actions

Copy link
Copy Markdown

Revision: 6587af478b6fdee398ec840992d70f703bbc431b

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

TaskStatus
preview-docsGitHub Actions

@github-actionsgithub-actionsBot 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

kou commented Feb 2, 2024

Copy link
Copy Markdown
Member

@github-actions crossbow submit preview-docs

@github-actions

Copy link
Copy Markdown

Revision: 9f0c727d9a929e5295c8e6ede49cac4f2f3d1181

Submitted crossbow builds: ursacomputing/crossbow @ actions-ea146315be

TaskStatus
preview-docsGitHub Actions

@kou

kou commented Feb 4, 2024

Copy link
Copy Markdown
Member

@github-actions crossbow submit preview-docs

@github-actions

Copy link
Copy Markdown

Revision: 102094668f7677aac543c17cd8947330203d17ff

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

TaskStatus
preview-docsGitHub Actions

@github-actionsgithub-actionsBot added awaiting change review Awaiting change review and removed awaiting changes Awaiting changes labels Feb 21, 2024
@jorisvandenbossche

Copy link
Copy Markdown
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
Copy Markdown
ContributorAuthor

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

@kou

kou commented Feb 24, 2024

Copy link
Copy Markdown
Member

Could you check #39879 (comment) ?

@Divyansh200102

Divyansh200102 commented Feb 25, 2024

Copy link
Copy Markdown
ContributorAuthor

Could you check #39879 (comment) ?

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

@kou

kou commented Feb 25, 2024

Copy link
Copy Markdown
Member

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
Copy Markdown
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

Divyansh200102 commented Jun 7, 2024 via email

Copy link
Copy Markdown
ContributorAuthor

Sign up for freeto 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.16.x

4 participants

@Divyansh200102@kou@AlenkaF@jorisvandenbossche
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

GH-39759: [Docs] Update pydata-sphinx-theme to 0.15.x - #39879

Closed
Divyansh200102 wants to merge 15 commits into
apache:mainfrom
Divyansh200102:Update-pydata-sphinx-theme-to-0.15.x
Closed

GH-39759: [Docs] Update pydata-sphinx-theme to 0.15.x#39879
Divyansh200102 wants to merge 15 commits into
apache:mainfrom
Divyansh200102:Update-pydata-sphinx-theme-to-0.15.x

Conversation

@Divyansh200102

@Divyansh200102Divyansh200102 commented Feb 1, 2024

Copy link
Copy Markdown
Contributor

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

@github-actions

Copy link
Copy Markdown

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
Copy Markdown
ContributorAuthor

@github-actions crossbow submit preview-docs

@github-actions

Copy link
Copy Markdown
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

@koukou changed the title MINOR: [DOCS] Update pydata-sphinx-theme to 0.15.x MINOR: [Docs] Update pydata-sphinx-theme to 0.15.xFeb 1, 2024
@kou

kou commented Feb 1, 2024

Copy link
Copy Markdown
Member

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

Could you use GH-39759 instead?

@kou

kou commented Feb 1, 2024

Copy link
Copy Markdown
Member

I think that we need to do like #39658 .

@Divyansh200102Divyansh200102 changed the title MINOR: [Docs] Update pydata-sphinx-theme to 0.15.xGH-39759: [Docs] Update pydata-sphinx-theme to 0.15.xFeb 1, 2024
@github-actions

Copy link
Copy Markdown

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

@kou

kou commented Feb 1, 2024

Copy link
Copy Markdown
Member

Could you also fill items in our PR template?

@Divyansh200102

Copy link
Copy Markdown
ContributorAuthor

I think that we need to do like #39658 .

Got it

@github-actions

Copy link
Copy Markdown

Revision: 9a5314f43ef5fb314f7c156cf5d91b98bcbc3192

Submitted crossbow builds: ursacomputing/crossbow @ actions-c32f679e0f

TaskStatus
preview-docsGitHub Actions

@github-actions

Copy link
Copy Markdown

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

2 similar comments
@github-actions

Copy link
Copy Markdown

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

@github-actions

Copy link
Copy Markdown

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

@kou

kou commented Feb 2, 2024

Copy link
Copy Markdown
Member

@github-actions crossbow submit preview-docs

Comment threaddocs/requirements.txt Outdated

Copy link
Copy Markdown
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
Copy Markdown
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
Copy Markdown
ContributorAuthor

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
Copy Markdown
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
Copy Markdown
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
Copy Markdown
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?

@Divyansh200102Divyansh200102Feb 14, 2024

Copy link
Copy Markdown
ContributorAuthor

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
Copy Markdown
ContributorAuthor

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
Copy Markdown
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.ymldocker-compose.yml 1:1 warning missing document start "---" (document-start)

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

@Divyansh200102Divyansh200102Feb 19, 2024

Copy link
Copy Markdown
ContributorAuthor

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

@github-actions

Copy link
Copy Markdown

Revision: 6587af478b6fdee398ec840992d70f703bbc431b

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

TaskStatus
preview-docsGitHub Actions

@github-actionsgithub-actionsBot 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

kou commented Feb 2, 2024

Copy link
Copy Markdown
Member

@github-actions crossbow submit preview-docs

@github-actions

Copy link
Copy Markdown

Revision: 9f0c727d9a929e5295c8e6ede49cac4f2f3d1181

Submitted crossbow builds: ursacomputing/crossbow @ actions-ea146315be

TaskStatus
preview-docsGitHub Actions

@kou

kou commented Feb 4, 2024

Copy link
Copy Markdown
Member

@github-actions crossbow submit preview-docs

@github-actions

Copy link
Copy Markdown

Revision: 102094668f7677aac543c17cd8947330203d17ff

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

TaskStatus
preview-docsGitHub Actions

@github-actionsgithub-actionsBot added awaiting change review Awaiting change review and removed awaiting changes Awaiting changes labels Feb 21, 2024
@jorisvandenbossche

Copy link
Copy Markdown
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
Copy Markdown
ContributorAuthor

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

@kou

kou commented Feb 24, 2024

Copy link
Copy Markdown
Member

Could you check #39879 (comment) ?

@Divyansh200102

Divyansh200102 commented Feb 25, 2024

Copy link
Copy Markdown
ContributorAuthor

Could you check #39879 (comment) ?

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

@kou

kou commented Feb 25, 2024

Copy link
Copy Markdown
Member

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
Copy Markdown
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

Divyansh200102 commented Jun 7, 2024 via email

Copy link
Copy Markdown
ContributorAuthor

Sign up for freeto 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.16.x

4 participants

@Divyansh200102@kou@AlenkaF@jorisvandenbossche
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

GH-39759: [Docs] Update pydata-sphinx-theme to 0.15.x - #39879

Closed
Divyansh200102 wants to merge 15 commits into
apache:mainfrom
Divyansh200102:Update-pydata-sphinx-theme-to-0.15.x
Closed

GH-39759: [Docs] Update pydata-sphinx-theme to 0.15.x#39879
Divyansh200102 wants to merge 15 commits into
apache:mainfrom
Divyansh200102:Update-pydata-sphinx-theme-to-0.15.x

Conversation

@Divyansh200102

@Divyansh200102Divyansh200102 commented Feb 1, 2024

Copy link
Copy Markdown
Contributor

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

@github-actions

Copy link
Copy Markdown

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
Copy Markdown
ContributorAuthor

@github-actions crossbow submit preview-docs

@github-actions

Copy link
Copy Markdown
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

@koukou changed the title MINOR: [DOCS] Update pydata-sphinx-theme to 0.15.x MINOR: [Docs] Update pydata-sphinx-theme to 0.15.xFeb 1, 2024
@kou

kou commented Feb 1, 2024

Copy link
Copy Markdown
Member

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

Could you use GH-39759 instead?

@kou

kou commented Feb 1, 2024

Copy link
Copy Markdown
Member

I think that we need to do like #39658 .

@Divyansh200102Divyansh200102 changed the title MINOR: [Docs] Update pydata-sphinx-theme to 0.15.xGH-39759: [Docs] Update pydata-sphinx-theme to 0.15.xFeb 1, 2024
@github-actions

Copy link
Copy Markdown

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

@kou

kou commented Feb 1, 2024

Copy link
Copy Markdown
Member

Could you also fill items in our PR template?

@Divyansh200102

Copy link
Copy Markdown
ContributorAuthor

I think that we need to do like #39658 .

Got it

@github-actions

Copy link
Copy Markdown

Revision: 9a5314f43ef5fb314f7c156cf5d91b98bcbc3192

Submitted crossbow builds: ursacomputing/crossbow @ actions-c32f679e0f

TaskStatus
preview-docsGitHub Actions

@github-actions

Copy link
Copy Markdown

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

2 similar comments
@github-actions

Copy link
Copy Markdown

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

@github-actions

Copy link
Copy Markdown

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

@kou

kou commented Feb 2, 2024

Copy link
Copy Markdown
Member

@github-actions crossbow submit preview-docs

Comment threaddocs/requirements.txt Outdated

Copy link
Copy Markdown
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
Copy Markdown
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
Copy Markdown
ContributorAuthor

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
Copy Markdown
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
Copy Markdown
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
Copy Markdown
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?

@Divyansh200102Divyansh200102Feb 14, 2024

Copy link
Copy Markdown
ContributorAuthor

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
Copy Markdown
ContributorAuthor

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
Copy Markdown
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.ymldocker-compose.yml 1:1 warning missing document start "---" (document-start)

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

@Divyansh200102Divyansh200102Feb 19, 2024

Copy link
Copy Markdown
ContributorAuthor

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

@github-actions

Copy link
Copy Markdown

Revision: 6587af478b6fdee398ec840992d70f703bbc431b

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

TaskStatus
preview-docsGitHub Actions

@github-actionsgithub-actionsBot 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

kou commented Feb 2, 2024

Copy link
Copy Markdown
Member

@github-actions crossbow submit preview-docs

@github-actions

Copy link
Copy Markdown

Revision: 9f0c727d9a929e5295c8e6ede49cac4f2f3d1181

Submitted crossbow builds: ursacomputing/crossbow @ actions-ea146315be

TaskStatus
preview-docsGitHub Actions

@kou

kou commented Feb 4, 2024

Copy link
Copy Markdown
Member

@github-actions crossbow submit preview-docs

@github-actions

Copy link
Copy Markdown

Revision: 102094668f7677aac543c17cd8947330203d17ff

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

TaskStatus
preview-docsGitHub Actions

@github-actionsgithub-actionsBot added awaiting change review Awaiting change review and removed awaiting changes Awaiting changes labels Feb 21, 2024
@jorisvandenbossche

Copy link
Copy Markdown
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
Copy Markdown
ContributorAuthor

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

@kou

kou commented Feb 24, 2024

Copy link
Copy Markdown
Member

Could you check #39879 (comment) ?

@Divyansh200102

Divyansh200102 commented Feb 25, 2024

Copy link
Copy Markdown
ContributorAuthor

Could you check #39879 (comment) ?

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

@kou

kou commented Feb 25, 2024

Copy link
Copy Markdown
Member

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
Copy Markdown
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

Divyansh200102 commented Jun 7, 2024 via email

Copy link
Copy Markdown
ContributorAuthor

Sign up for freeto 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.16.x

4 participants

@Divyansh200102@kou@AlenkaF@jorisvandenbossche
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

GH-39759: [Docs] Update pydata-sphinx-theme to 0.15.x - #39879

Closed
Divyansh200102 wants to merge 15 commits into
apache:mainfrom
Divyansh200102:Update-pydata-sphinx-theme-to-0.15.x
Closed

GH-39759: [Docs] Update pydata-sphinx-theme to 0.15.x#39879
Divyansh200102 wants to merge 15 commits into
apache:mainfrom
Divyansh200102:Update-pydata-sphinx-theme-to-0.15.x

Conversation

@Divyansh200102

@Divyansh200102Divyansh200102 commented Feb 1, 2024

Copy link
Copy Markdown
Contributor

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

@github-actions

Copy link
Copy Markdown

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
Copy Markdown
ContributorAuthor

@github-actions crossbow submit preview-docs

@github-actions

Copy link
Copy Markdown
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

@koukou changed the title MINOR: [DOCS] Update pydata-sphinx-theme to 0.15.x MINOR: [Docs] Update pydata-sphinx-theme to 0.15.xFeb 1, 2024
@kou

kou commented Feb 1, 2024

Copy link
Copy Markdown
Member

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

Could you use GH-39759 instead?

@kou

kou commented Feb 1, 2024

Copy link
Copy Markdown
Member

I think that we need to do like #39658 .

@Divyansh200102Divyansh200102 changed the title MINOR: [Docs] Update pydata-sphinx-theme to 0.15.xGH-39759: [Docs] Update pydata-sphinx-theme to 0.15.xFeb 1, 2024
@github-actions

Copy link
Copy Markdown

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

@kou

kou commented Feb 1, 2024

Copy link
Copy Markdown
Member

Could you also fill items in our PR template?

@Divyansh200102

Copy link
Copy Markdown
ContributorAuthor

I think that we need to do like #39658 .

Got it

@github-actions

Copy link
Copy Markdown

Revision: 9a5314f43ef5fb314f7c156cf5d91b98bcbc3192

Submitted crossbow builds: ursacomputing/crossbow @ actions-c32f679e0f

TaskStatus
preview-docsGitHub Actions

@github-actions

Copy link
Copy Markdown

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

2 similar comments
@github-actions

Copy link
Copy Markdown

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

@github-actions

Copy link
Copy Markdown

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

@kou

kou commented Feb 2, 2024

Copy link
Copy Markdown
Member

@github-actions crossbow submit preview-docs

Comment threaddocs/requirements.txt Outdated

Copy link
Copy Markdown
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
Copy Markdown
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
Copy Markdown
ContributorAuthor

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
Copy Markdown
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
Copy Markdown
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
Copy Markdown
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?

@Divyansh200102Divyansh200102Feb 14, 2024

Copy link
Copy Markdown
ContributorAuthor

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
Copy Markdown
ContributorAuthor

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
Copy Markdown
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.ymldocker-compose.yml 1:1 warning missing document start "---" (document-start)

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

@Divyansh200102Divyansh200102Feb 19, 2024

Copy link
Copy Markdown
ContributorAuthor

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

@github-actions

Copy link
Copy Markdown

Revision: 6587af478b6fdee398ec840992d70f703bbc431b

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

TaskStatus
preview-docsGitHub Actions

@github-actionsgithub-actionsBot 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

kou commented Feb 2, 2024

Copy link
Copy Markdown
Member

@github-actions crossbow submit preview-docs

@github-actions

Copy link
Copy Markdown

Revision: 9f0c727d9a929e5295c8e6ede49cac4f2f3d1181

Submitted crossbow builds: ursacomputing/crossbow @ actions-ea146315be

TaskStatus
preview-docsGitHub Actions

@kou

kou commented Feb 4, 2024

Copy link
Copy Markdown
Member

@github-actions crossbow submit preview-docs

@github-actions

Copy link
Copy Markdown

Revision: 102094668f7677aac543c17cd8947330203d17ff

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

TaskStatus
preview-docsGitHub Actions

@github-actionsgithub-actionsBot added awaiting change review Awaiting change review and removed awaiting changes Awaiting changes labels Feb 21, 2024
@jorisvandenbossche

Copy link
Copy Markdown
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
Copy Markdown
ContributorAuthor

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

@kou

kou commented Feb 24, 2024

Copy link
Copy Markdown
Member

Could you check #39879 (comment) ?

@Divyansh200102

Divyansh200102 commented Feb 25, 2024

Copy link
Copy Markdown
ContributorAuthor

Could you check #39879 (comment) ?

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

@kou

kou commented Feb 25, 2024

Copy link
Copy Markdown
Member

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
Copy Markdown
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

Divyansh200102 commented Jun 7, 2024 via email

Copy link
Copy Markdown
ContributorAuthor

Sign up for freeto 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.16.x

4 participants

@Divyansh200102@kou@AlenkaF@jorisvandenbossche
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

GH-39759: [Docs] Update pydata-sphinx-theme to 0.15.x - #39879

Closed
Divyansh200102 wants to merge 15 commits into
apache:mainfrom
Divyansh200102:Update-pydata-sphinx-theme-to-0.15.x
Closed

GH-39759: [Docs] Update pydata-sphinx-theme to 0.15.x#39879
Divyansh200102 wants to merge 15 commits into
apache:mainfrom
Divyansh200102:Update-pydata-sphinx-theme-to-0.15.x

Conversation

@Divyansh200102

@Divyansh200102Divyansh200102 commented Feb 1, 2024

Copy link
Copy Markdown
Contributor

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

@github-actions

Copy link
Copy Markdown

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
Copy Markdown
ContributorAuthor

@github-actions crossbow submit preview-docs

@github-actions

Copy link
Copy Markdown
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

@koukou changed the title MINOR: [DOCS] Update pydata-sphinx-theme to 0.15.x MINOR: [Docs] Update pydata-sphinx-theme to 0.15.xFeb 1, 2024
@kou

kou commented Feb 1, 2024

Copy link
Copy Markdown
Member

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

Could you use GH-39759 instead?

@kou

kou commented Feb 1, 2024

Copy link
Copy Markdown
Member

I think that we need to do like #39658 .

@Divyansh200102Divyansh200102 changed the title MINOR: [Docs] Update pydata-sphinx-theme to 0.15.xGH-39759: [Docs] Update pydata-sphinx-theme to 0.15.xFeb 1, 2024
@github-actions

Copy link
Copy Markdown

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

@kou

kou commented Feb 1, 2024

Copy link
Copy Markdown
Member

Could you also fill items in our PR template?

@Divyansh200102

Copy link
Copy Markdown
ContributorAuthor

I think that we need to do like #39658 .

Got it

@github-actions

Copy link
Copy Markdown

Revision: 9a5314f43ef5fb314f7c156cf5d91b98bcbc3192

Submitted crossbow builds: ursacomputing/crossbow @ actions-c32f679e0f

TaskStatus
preview-docsGitHub Actions

@github-actions

Copy link
Copy Markdown

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

2 similar comments
@github-actions

Copy link
Copy Markdown

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

@github-actions

Copy link
Copy Markdown

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

@kou

kou commented Feb 2, 2024

Copy link
Copy Markdown
Member

@github-actions crossbow submit preview-docs

Comment threaddocs/requirements.txt Outdated

Copy link
Copy Markdown
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
Copy Markdown
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
Copy Markdown
ContributorAuthor

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
Copy Markdown
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
Copy Markdown
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
Copy Markdown
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?

@Divyansh200102Divyansh200102Feb 14, 2024

Copy link
Copy Markdown
ContributorAuthor

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
Copy Markdown
ContributorAuthor

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
Copy Markdown
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.ymldocker-compose.yml 1:1 warning missing document start "---" (document-start)

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

@Divyansh200102Divyansh200102Feb 19, 2024

Copy link
Copy Markdown
ContributorAuthor

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

@github-actions

Copy link
Copy Markdown

Revision: 6587af478b6fdee398ec840992d70f703bbc431b

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

TaskStatus
preview-docsGitHub Actions

@github-actionsgithub-actionsBot 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

kou commented Feb 2, 2024

Copy link
Copy Markdown
Member

@github-actions crossbow submit preview-docs

@github-actions

Copy link
Copy Markdown

Revision: 9f0c727d9a929e5295c8e6ede49cac4f2f3d1181

Submitted crossbow builds: ursacomputing/crossbow @ actions-ea146315be

TaskStatus
preview-docsGitHub Actions

@kou

kou commented Feb 4, 2024

Copy link
Copy Markdown
Member

@github-actions crossbow submit preview-docs

@github-actions

Copy link
Copy Markdown

Revision: 102094668f7677aac543c17cd8947330203d17ff

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

TaskStatus
preview-docsGitHub Actions

@github-actionsgithub-actionsBot added awaiting change review Awaiting change review and removed awaiting changes Awaiting changes labels Feb 21, 2024
@jorisvandenbossche

Copy link
Copy Markdown
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
Copy Markdown
ContributorAuthor

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

@kou

kou commented Feb 24, 2024

Copy link
Copy Markdown
Member

Could you check #39879 (comment) ?

@Divyansh200102

Divyansh200102 commented Feb 25, 2024

Copy link
Copy Markdown
ContributorAuthor

Could you check #39879 (comment) ?

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

@kou

kou commented Feb 25, 2024

Copy link
Copy Markdown
Member

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
Copy Markdown
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

Divyansh200102 commented Jun 7, 2024 via email

Copy link
Copy Markdown
ContributorAuthor

Sign up for freeto 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.16.x

4 participants

@Divyansh200102@kou@AlenkaF@jorisvandenbossche
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

GH-39759: [Docs] Update pydata-sphinx-theme to 0.15.x - #39879

Closed
Divyansh200102 wants to merge 15 commits into
apache:mainfrom
Divyansh200102:Update-pydata-sphinx-theme-to-0.15.x
Closed

GH-39759: [Docs] Update pydata-sphinx-theme to 0.15.x#39879
Divyansh200102 wants to merge 15 commits into
apache:mainfrom
Divyansh200102:Update-pydata-sphinx-theme-to-0.15.x

Conversation

@Divyansh200102

@Divyansh200102Divyansh200102 commented Feb 1, 2024

Copy link
Copy Markdown
Contributor

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

@github-actions

Copy link
Copy Markdown

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
Copy Markdown
ContributorAuthor

@github-actions crossbow submit preview-docs

@github-actions

Copy link
Copy Markdown
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

@koukou changed the title MINOR: [DOCS] Update pydata-sphinx-theme to 0.15.x MINOR: [Docs] Update pydata-sphinx-theme to 0.15.xFeb 1, 2024
@kou

kou commented Feb 1, 2024

Copy link
Copy Markdown
Member

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

Could you use GH-39759 instead?

@kou

kou commented Feb 1, 2024

Copy link
Copy Markdown
Member

I think that we need to do like #39658 .

@Divyansh200102Divyansh200102 changed the title MINOR: [Docs] Update pydata-sphinx-theme to 0.15.xGH-39759: [Docs] Update pydata-sphinx-theme to 0.15.xFeb 1, 2024
@github-actions

Copy link
Copy Markdown

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

@kou

kou commented Feb 1, 2024

Copy link
Copy Markdown
Member

Could you also fill items in our PR template?

@Divyansh200102

Copy link
Copy Markdown
ContributorAuthor

I think that we need to do like #39658 .

Got it

@github-actions

Copy link
Copy Markdown

Revision: 9a5314f43ef5fb314f7c156cf5d91b98bcbc3192

Submitted crossbow builds: ursacomputing/crossbow @ actions-c32f679e0f

TaskStatus
preview-docsGitHub Actions

@github-actions

Copy link
Copy Markdown

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

2 similar comments
@github-actions

Copy link
Copy Markdown

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

@github-actions

Copy link
Copy Markdown

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

@kou

kou commented Feb 2, 2024

Copy link
Copy Markdown
Member

@github-actions crossbow submit preview-docs

Comment threaddocs/requirements.txt Outdated

Copy link
Copy Markdown
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
Copy Markdown
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
Copy Markdown
ContributorAuthor

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
Copy Markdown
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
Copy Markdown
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
Copy Markdown
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?

@Divyansh200102Divyansh200102Feb 14, 2024

Copy link
Copy Markdown
ContributorAuthor

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
Copy Markdown
ContributorAuthor

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
Copy Markdown
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.ymldocker-compose.yml 1:1 warning missing document start "---" (document-start)

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

@Divyansh200102Divyansh200102Feb 19, 2024

Copy link
Copy Markdown
ContributorAuthor

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

@github-actions

Copy link
Copy Markdown

Revision: 6587af478b6fdee398ec840992d70f703bbc431b

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

TaskStatus
preview-docsGitHub Actions

@github-actionsgithub-actionsBot 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

kou commented Feb 2, 2024

Copy link
Copy Markdown
Member

@github-actions crossbow submit preview-docs

@github-actions

Copy link
Copy Markdown

Revision: 9f0c727d9a929e5295c8e6ede49cac4f2f3d1181

Submitted crossbow builds: ursacomputing/crossbow @ actions-ea146315be

TaskStatus
preview-docsGitHub Actions

@kou

kou commented Feb 4, 2024

Copy link
Copy Markdown
Member

@github-actions crossbow submit preview-docs

@github-actions

Copy link
Copy Markdown

Revision: 102094668f7677aac543c17cd8947330203d17ff

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

TaskStatus
preview-docsGitHub Actions

@github-actionsgithub-actionsBot added awaiting change review Awaiting change review and removed awaiting changes Awaiting changes labels Feb 21, 2024
@jorisvandenbossche

Copy link
Copy Markdown
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
Copy Markdown
ContributorAuthor

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

@kou

kou commented Feb 24, 2024

Copy link
Copy Markdown
Member

Could you check #39879 (comment) ?

@Divyansh200102

Divyansh200102 commented Feb 25, 2024

Copy link
Copy Markdown
ContributorAuthor

Could you check #39879 (comment) ?

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

@kou

kou commented Feb 25, 2024

Copy link
Copy Markdown
Member

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
Copy Markdown
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

Divyansh200102 commented Jun 7, 2024 via email

Copy link
Copy Markdown
ContributorAuthor

Sign up for freeto 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.16.x

4 participants

@Divyansh200102@kou@AlenkaF@jorisvandenbossche