Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Docs] Enable dark mode on documentation site #32451

Closed
asfimport opened this issue Jul 20, 2022 · 1 comment · Fixed by #36591
Closed

[Docs] Enable dark mode on documentation site #32451

asfimport opened this issue Jul 20, 2022 · 1 comment · Fixed by #36591
Labels
Type: enhancement

Comments

@asfimport
Copy link
Collaborator

asfimport commented Jul 20, 2022 •
edited
Loading

pydata-sphinx-theme adds dark mode in version 0.9.0. We will need to adapt our logo (see docs). There are also some places in the docs where we may need to adjust additional CSS. See attached screenshot.

Reporter: Will Jones / @wjones127

Related issues:

Original Issue Attachments:

Note: This issue was originally created as ARROW-17152. Please see the migration documentation for further details.
@asfimport asfimport added this to the 11.0.0 milestone Jan 11, 2023
@asfimport asfimport mentioned this issue Jan 11, 2023
Closed
@raulcd raulcd removed this from the 11.0.0 milestone Jan 11, 2023
@AlenkaF
Copy link
Member

AlenkaF commented Jul 10, 2023

This issue will be fixed with #36591 where the theme is being updated.

@AlenkaF AlenkaF closed this as completed Jul 10, 2023
@jorisvandenbossche jorisvandenbossche mentioned this issue Jul 10, 2023
Merged
jorisvandenbossche pushed a commit that referenced this issue Sep 27, 2023
@AlenkaF @kou
GH-36590: [Docs] Support Pydata Sphinx Theme 0.14.0 (#36591)
7dc9f69 
Preview: http://crossbow.voltrondata.com/pr_docs/36591/

### Rationale for this change

The Pydata Sphinx Theme that we use for our documentation has been pinned due to bigger changes in the theme layout. It needs to be unpinned and our layout needs to be updated.

### What changes are included in this PR?

Update of the Pydata Sphinx Theme and changes to our layout/structure:

- dark/light mode
- top menu bar
- search button in the top right navigation bar
- drop down from the theme layout in the top right navigation bar
- version warnings bar from the theme layout
- main landing page and the landing page for the dev docs

⚠️ Needs an update of the [versions.json](https://github.com/apache/arrow-site/blob/AlenkaF-patch-1/docs/_static/versions.json)

### Are these changes tested?

Yes, locally. Will also add docs preview via GitHub actions.

### Are there any user-facing changes?

No.

* Closes: #32451
* Closes: #36590

Lead-authored-by: AlenkaF <frim.alenka@gmail.com>
Co-authored-by: Sutou Kouhei <kou@clear-code.com>
Signed-off-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
etseidl pushed a commit to etseidl/arrow that referenced this issue Sep 28, 2023
@AlenkaF @kou @etseidl
apacheGH-36590: [Docs] Support Pydata Sphinx Theme 0.14.0 (apache#36591)
513306e 
Preview: http://crossbow.voltrondata.com/pr_docs/36591/

### Rationale for this change

The Pydata Sphinx Theme that we use for our documentation has been pinned due to bigger changes in the theme layout. It needs to be unpinned and our layout needs to be updated.

### What changes are included in this PR?

Update of the Pydata Sphinx Theme and changes to our layout/structure:

- dark/light mode
- top menu bar
- search button in the top right navigation bar
- drop down from the theme layout in the top right navigation bar
- version warnings bar from the theme layout
- main landing page and the landing page for the dev docs

⚠️ Needs an update of the [versions.json](https://github.com/apache/arrow-site/blob/AlenkaF-patch-1/docs/_static/versions.json)

### Are these changes tested?

Yes, locally. Will also add docs preview via GitHub actions.

### Are there any user-facing changes?

No.

* Closes: apache#32451
* Closes: apache#36590

Lead-authored-by: AlenkaF <frim.alenka@gmail.com>
Co-authored-by: Sutou Kouhei <kou@clear-code.com>
Signed-off-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
JerAguilon pushed a commit to JerAguilon/arrow that referenced this issue Oct 23, 2023
@AlenkaF @kou
apacheGH-36590: [Docs] Support Pydata Sphinx Theme 0.14.0 (apache#36591)
576e830 
Preview: http://crossbow.voltrondata.com/pr_docs/36591/

### Rationale for this change

The Pydata Sphinx Theme that we use for our documentation has been pinned due to bigger changes in the theme layout. It needs to be unpinned and our layout needs to be updated.

### What changes are included in this PR?

Update of the Pydata Sphinx Theme and changes to our layout/structure:

- dark/light mode
- top menu bar
- search button in the top right navigation bar
- drop down from the theme layout in the top right navigation bar
- version warnings bar from the theme layout
- main landing page and the landing page for the dev docs

⚠️ Needs an update of the [versions.json](https://github.com/apache/arrow-site/blob/AlenkaF-patch-1/docs/_static/versions.json)

### Are these changes tested?

Yes, locally. Will also add docs preview via GitHub actions.

### Are there any user-facing changes?

No.

* Closes: apache#32451
* Closes: apache#36590

Lead-authored-by: AlenkaF <frim.alenka@gmail.com>
Co-authored-by: Sutou Kouhei <kou@clear-code.com>
Signed-off-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
loicalleyne pushed a commit to loicalleyne/arrow that referenced this issue Nov 13, 2023
@AlenkaF @kou @loicalleyne
apacheGH-36590: [Docs] Support Pydata Sphinx Theme 0.14.0 (apache#36591)
6e1b5df 
Preview: http://crossbow.voltrondata.com/pr_docs/36591/

### Rationale for this change

The Pydata Sphinx Theme that we use for our documentation has been pinned due to bigger changes in the theme layout. It needs to be unpinned and our layout needs to be updated.

### What changes are included in this PR?

Update of the Pydata Sphinx Theme and changes to our layout/structure:

- dark/light mode
- top menu bar
- search button in the top right navigation bar
- drop down from the theme layout in the top right navigation bar
- version warnings bar from the theme layout
- main landing page and the landing page for the dev docs

⚠️ Needs an update of the [versions.json](https://github.com/apache/arrow-site/blob/AlenkaF-patch-1/docs/_static/versions.json)

### Are these changes tested?

Yes, locally. Will also add docs preview via GitHub actions.

### Are there any user-facing changes?

No.

* Closes: apache#32451
* Closes: apache#36590

Lead-authored-by: AlenkaF <frim.alenka@gmail.com>
Co-authored-by: Sutou Kouhei <kou@clear-code.com>
Signed-off-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
dgreiss pushed a commit to dgreiss/arrow that referenced this issue Feb 19, 2024
@AlenkaF @kou @dgreiss
apacheGH-36590: [Docs] Support Pydata Sphinx Theme 0.14.0 (apache#36591)
231c684 
Preview: http://crossbow.voltrondata.com/pr_docs/36591/

### Rationale for this change

The Pydata Sphinx Theme that we use for our documentation has been pinned due to bigger changes in the theme layout. It needs to be unpinned and our layout needs to be updated.

### What changes are included in this PR?

Update of the Pydata Sphinx Theme and changes to our layout/structure:

- dark/light mode
- top menu bar
- search button in the top right navigation bar
- drop down from the theme layout in the top right navigation bar
- version warnings bar from the theme layout
- main landing page and the landing page for the dev docs

⚠️ Needs an update of the [versions.json](https://github.com/apache/arrow-site/blob/AlenkaF-patch-1/docs/_static/versions.json)

### Are these changes tested?

Yes, locally. Will also add docs preview via GitHub actions.

### Are there any user-facing changes?

No.

* Closes: apache#32451
* Closes: apache#36590

Lead-authored-by: AlenkaF <frim.alenka@gmail.com>
Co-authored-by: Sutou Kouhei <kou@clear-code.com>
Signed-off-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Type: enhancement
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

GH-36590: [Docs] Support Pydata Sphinx Theme 0.14.0 AlenkaF/arrow
4 participants
@raulcd @jorisvandenbossche @AlenkaF @asfimport