You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@arrow.apache.org by "AlenkaF (via GitHub)" <gi...@apache.org> on 2023/07/10 11:08:31 UTC

[GitHub] [arrow] AlenkaF opened a new pull request, #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

AlenkaF opened a new pull request, #36591:
URL: https://github.com/apache/arrow/pull/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 Pydata Sphinx Theme and make changes to our layout to enable/update:
   
   - 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
   
   ### Are these changes tested?
   
   Yes, locally. Will also add docs preview via GitHub actions.
   
   ### Are there any user-facing changes?
   
   No.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] jorisvandenbossche commented on pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "jorisvandenbossche (via GitHub)" <gi...@apache.org>.
jorisvandenbossche commented on PR #36591:
URL: https://github.com/apache/arrow/pull/36591#issuecomment-1632533168

   Regarding colors, now we are updating it, it might be worth to directly check with the latest development version of the theme, as I know the colors are being overhauled (https://pydata-sphinx-theme.readthedocs.io/en/latest/user_guide/install.html#development-version).  
   (and for example, I think in the theme the h1 and h2 headers are now also black, like we did on our side) 
   
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] AlenkaF commented on pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "AlenkaF (via GitHub)" <gi...@apache.org>.
AlenkaF commented on PR #36591:
URL: https://github.com/apache/arrow/pull/36591#issuecomment-1700936663

   > Did you check locally that the versionwarnings are still working?
   
   They can be checked on the [PR docs build](https://arrow.apache.org/docs/12.0/index.html). Will run it again with the new changes.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] github-actions[bot] commented on pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #36591:
URL: https://github.com/apache/arrow/pull/36591#issuecomment-1709961311

   Revision: d8776f51df317feb5e348d2a9ad1325d679bf2e5
   
   Submitted crossbow builds: [ursacomputing/crossbow @ actions-7422f7bee7](https://github.com/ursacomputing/crossbow/branches/all?query=actions-7422f7bee7)
   
   |Task|Status|
   |----|------|
   |preview-docs|[![Github Actions](https://github.com/ursacomputing/crossbow/workflows/Crossbow/badge.svg?branch=actions-7422f7bee7-github-preview-docs)](https://github.com/ursacomputing/crossbow/actions/runs/6108946286/job/16578966268)|


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] danepitkin commented on a diff in pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "danepitkin (via GitHub)" <gi...@apache.org>.
danepitkin commented on code in PR #36591:
URL: https://github.com/apache/arrow/pull/36591#discussion_r1324679263


##########
docs/source/index.rst:
##########
@@ -35,11 +37,71 @@ such topics as:
 **To learn how to use Arrow refer to the documentation specific to your
 target environment.**
 
+.. grid:: 2
+   :gutter: 4
+   :padding: 2 2 0 0
+   :class-container: sd-text-center
+
+   .. grid-item-card:: Specifications and protocols
+      :class-card: contrib-card
+      :shadow: none
+
+      Read about the Apache Arrow format
+      specifications and protocols.
+
+      +++
+
+      .. button-ref:: format
+         :ref-type: ref
+         :click-parent:
+         :color: primary
+         :expand:
+
+         To the Specifications and protocols

Review Comment:
   nit: Can we capitalize `Protocols` so that it matches the navigation tab?



##########
docs/source/conf.py:
##########
@@ -319,7 +340,7 @@
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
 #
-html_logo = "_static/arrow.png"
+# html_logo = "_static/arrow.png"

Review Comment:
   Ah good to know! I'm okay with leaving it as-is.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] AlenkaF commented on a diff in pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "AlenkaF (via GitHub)" <gi...@apache.org>.
AlenkaF commented on code in PR #36591:
URL: https://github.com/apache/arrow/pull/36591#discussion_r1324055536


##########
docs/source/conf.py:
##########
@@ -319,7 +340,7 @@
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
 #
-html_logo = "_static/arrow.png"
+# html_logo = "_static/arrow.png"

Review Comment:
   I have been following the idea of commenting out default settings of the theme so that it is easy to see what can be changed. At least that is what I am seeing in the `docs/source/conf.py`. If I am mistaken, I am happy to remove it.
   
   Some examples of commented code:
   - https://github.com/apache/arrow/blob/2a56d4598a3a401447c91645448853b940e86fbe/docs/source/conf.py#L106-L108
   - https://github.com/apache/arrow/blob/2a56d4598a3a401447c91645448853b940e86fbe/docs/source/conf.py#L315-L317
   - https://github.com/apache/arrow/blob/2a56d4598a3a401447c91645448853b940e86fbe/docs/source/conf.py#L366-L420



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] AlenkaF commented on a diff in pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "AlenkaF (via GitHub)" <gi...@apache.org>.
AlenkaF commented on code in PR #36591:
URL: https://github.com/apache/arrow/pull/36591#discussion_r1324163498


##########
docs/source/index.rst:
##########
@@ -35,11 +37,216 @@ such topics as:
 **To learn how to use Arrow refer to the documentation specific to your
 target environment.**
 
+.. grid:: 2
+   :gutter: 4
+   :padding: 2 2 0 0
+   :class-container: sd-text-center
+
+   .. grid-item-card:: Format
+      :class-card: contrib-card
+      :shadow: none
+
+      Read about the Apache Arrow format
+      specifications and protocols.
+
+      +++
+
+      .. button-ref:: format
+         :ref-type: ref
+         :click-parent:
+         :color: primary
+         :expand:
+
+         To the specifications
+
+   .. grid-item-card:: Developing
+      :class-card: contrib-card
+      :shadow: none
+
+      Find the documentation on the topic of
+      contributions, reviews, building of the libraries
+      from source, building of the documentation, 
+      continuous integration, benchmarks and the
+      release process.
+
+      +++
+
+      .. button-ref:: developers
+         :ref-type: ref
+         :click-parent:
+         :color: primary
+         :expand:
+
+         To the documentation 
+
+Supported environments

Review Comment:
   Oh I forgot, if I change the layout here, the structure of the top navigation changes also. I would keep it as is with implementations coming third as I explained in the comment: https://github.com/apache/arrow/pull/36591#discussion_r1324081567
   
   I do agree with making it nicer for a new user coming to the docs though. Will try to see if I can come up with any good ideas without changing the structure of the top navigation.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] AlenkaF commented on a diff in pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "AlenkaF (via GitHub)" <gi...@apache.org>.
AlenkaF commented on code in PR #36591:
URL: https://github.com/apache/arrow/pull/36591#discussion_r1324226018


##########
docs/source/index.rst:
##########
@@ -35,11 +37,216 @@ such topics as:
 **To learn how to use Arrow refer to the documentation specific to your
 target environment.**
 
+.. grid:: 2
+   :gutter: 4
+   :padding: 2 2 0 0
+   :class-container: sd-text-center
+
+   .. grid-item-card:: Format
+      :class-card: contrib-card
+      :shadow: none
+
+      Read about the Apache Arrow format
+      specifications and protocols.
+
+      +++
+
+      .. button-ref:: format
+         :ref-type: ref
+         :click-parent:
+         :color: primary
+         :expand:
+
+         To the specifications
+
+   .. grid-item-card:: Developing
+      :class-card: contrib-card
+      :shadow: none
+
+      Find the documentation on the topic of
+      contributions, reviews, building of the libraries
+      from source, building of the documentation, 
+      continuous integration, benchmarks and the
+      release process.
+
+      +++
+
+      .. button-ref:: developers
+         :ref-type: ref
+         :click-parent:
+         :color: primary
+         :expand:
+
+         To the documentation 
+
+Supported environments
+----------------------
+
+.. grid:: auto
+
+   .. grid-item::
+
+      .. button-ref:: c-glib
+         :ref-type: ref
+         :color: info
+         :shadow:
+
+         C/GLib
+
+   .. grid-item::
+
+      .. button-ref:: cpp
+         :ref-type: ref
+         :color: info
+         :expand:
+
+         C++
+
+   .. grid-item::
+
+      .. button-link:: https://github.com/apache/arrow/blob/main/csharp/README.md
+         :color: info
+         :expand:
+
+         C#
+   
+   .. grid-item::
+
+      .. button-link:: https://pkg.go.dev/github.com/apache/arrow/go
+         :color: info
+         :expand:
+
+         Go
+
+   .. grid-item::
+
+      .. button-ref:: java
+         :ref-type: ref
+         :color: info
+         :expand:
+
+         Java
+
+   .. grid-item::
+
+      .. button-ref:: js
+         :ref-type: ref
+         :color: info
+         :expand:
+
+         JavaScript
+
+   .. grid-item::
+
+      .. button-link:: https://arrow.apache.org/julia/
+         :color: info
+         :expand:
+
+         Julia
+
+   .. grid-item::
+
+      .. button-link:: https://github.com/apache/arrow/blob/main/matlab/README.md
+         :ref-type: ref
+         :color: info
+         :expand:
+
+         Matlab
+
+   .. grid-item::
+
+      .. button-ref:: python
+         :ref-type: ref
+         :color: info
+         :expand:
+
+         Python
+
+   .. grid-item::
+
+      .. button-ref:: r
+         :ref-type: ref
+         :color: info
+         :expand:
+
+         R
+
+   .. grid-item::
+
+      .. button-link:: https://github.com/apache/arrow/blob/main/ruby/README.md
+         :color: info
+         :expand:
+
+         Ruby
+
+   .. grid-item::
+
+      .. button-link:: https://docs.rs/crate/arrow/
+         :color: info
+         :expand:
+
+         Rust
+
+`Implementation Status for all of the languages <status>`_

Review Comment:
   Should work now: https://github.com/apache/arrow/pull/36591/commits/803a336b8e7410d158cfa45e4042493230a48fe7



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] conbench-apache-arrow[bot] commented on pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.14.0

Posted by "conbench-apache-arrow[bot] (via GitHub)" <gi...@apache.org>.
conbench-apache-arrow[bot] commented on PR #36591:
URL: https://github.com/apache/arrow/pull/36591#issuecomment-1737804656

   After merging your PR, Conbench analyzed the 5 benchmarking runs that have been run so far on merge-commit 7dc9f69a8a77345d0ec7920af9224ef96d7f5f78.
   
   There were no benchmark performance regressions. 🎉
   
   The [full Conbench report](https://github.com/apache/arrow/runs/17189477167) has more details.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] AlenkaF commented on a diff in pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "AlenkaF (via GitHub)" <gi...@apache.org>.
AlenkaF commented on code in PR #36591:
URL: https://github.com/apache/arrow/pull/36591#discussion_r1311272396


##########
docs/source/_static/theme_overrides.css:
##########
@@ -21,43 +21,17 @@
 /* Customizing with theme CSS variables */
 
 :root {
-  --pst-color-active-navigation: 215, 70, 51;
-  --pst-color-link-hover: 215, 70, 51;
-  --pst-color-headerlink: 215, 70, 51;
-  /* Use normal text color (like h3, ..) instead of primary color */
-  --pst-color-h1: var(--color-text-base);
-  --pst-color-h2: var(--color-text-base);
-  /* Use softer blue from bootstrap's default info color */
-  --pst-color-info: 23, 162, 184;
-  --pst-header-height: 0px;
-}
-
-code {
-  color: rgb(215, 70, 51);
+  --pst-header-height: 6rem;
+  --pst-font-weight-heading: 600;

Review Comment:
   Yes, correct.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] github-actions[bot] commented on pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #36591:
URL: https://github.com/apache/arrow/pull/36591#issuecomment-1700940937

   Revision: 8a4ed73fd45a54ec1bf092140592334a5ccd5ce7
   
   Submitted crossbow builds: [ursacomputing/crossbow @ actions-30d2bfa87f](https://github.com/ursacomputing/crossbow/branches/all?query=actions-30d2bfa87f)
   
   |Task|Status|
   |----|------|
   |preview-docs|[![Github Actions](https://github.com/ursacomputing/crossbow/workflows/Crossbow/badge.svg?branch=actions-30d2bfa87f-github-preview-docs)](https://github.com/ursacomputing/crossbow/actions/runs/6037274125/job/16381223944)|


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] AlenkaF commented on a diff in pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "AlenkaF (via GitHub)" <gi...@apache.org>.
AlenkaF commented on code in PR #36591:
URL: https://github.com/apache/arrow/pull/36591#discussion_r1324081567


##########
docs/source/index.rst:
##########
@@ -35,11 +37,216 @@ such topics as:
 **To learn how to use Arrow refer to the documentation specific to your
 target environment.**
 
+.. grid:: 2
+   :gutter: 4
+   :padding: 2 2 0 0
+   :class-container: sd-text-center
+
+   .. grid-item-card:: Format
+      :class-card: contrib-card
+      :shadow: none
+
+      Read about the Apache Arrow format
+      specifications and protocols.
+
+      +++
+
+      .. button-ref:: format
+         :ref-type: ref
+         :click-parent:
+         :color: primary
+         :expand:
+
+         To the specifications
+
+   .. grid-item-card:: Developing
+      :class-card: contrib-card
+      :shadow: none
+
+      Find the documentation on the topic of
+      contributions, reviews, building of the libraries
+      from source, building of the documentation, 
+      continuous integration, benchmarks and the
+      release process.
+
+      +++
+
+      .. button-ref:: developers
+         :ref-type: ref
+         :click-parent:
+         :color: primary
+         :expand:
+
+         To the documentation 
+
+Supported environments
+----------------------
+
+.. grid:: auto
+
+   .. grid-item::
+
+      .. button-ref:: c-glib
+         :ref-type: ref
+         :color: info
+         :shadow:
+
+         C/GLib
+
+   .. grid-item::
+
+      .. button-ref:: cpp
+         :ref-type: ref
+         :color: info
+         :expand:
+
+         C++
+
+   .. grid-item::
+
+      .. button-link:: https://github.com/apache/arrow/blob/main/csharp/README.md
+         :color: info
+         :expand:
+
+         C#
+   
+   .. grid-item::
+
+      .. button-link:: https://pkg.go.dev/github.com/apache/arrow/go
+         :color: info
+         :expand:
+
+         Go
+
+   .. grid-item::
+
+      .. button-ref:: java
+         :ref-type: ref
+         :color: info
+         :expand:
+
+         Java
+
+   .. grid-item::
+
+      .. button-ref:: js
+         :ref-type: ref
+         :color: info
+         :expand:
+
+         JavaScript
+
+   .. grid-item::
+
+      .. button-link:: https://arrow.apache.org/julia/
+         :color: info
+         :expand:
+
+         Julia
+
+   .. grid-item::
+
+      .. button-link:: https://github.com/apache/arrow/blob/main/matlab/README.md
+         :ref-type: ref
+         :color: info
+         :expand:
+
+         Matlab
+
+   .. grid-item::
+
+      .. button-ref:: python
+         :ref-type: ref
+         :color: info
+         :expand:
+
+         Python
+
+   .. grid-item::
+
+      .. button-ref:: r
+         :ref-type: ref
+         :color: info
+         :expand:
+
+         R
+
+   .. grid-item::
+
+      .. button-link:: https://github.com/apache/arrow/blob/main/ruby/README.md
+         :color: info
+         :expand:
+
+         Ruby
+
+   .. grid-item::
+
+      .. button-link:: https://docs.rs/crate/arrow/
+         :color: info
+         :expand:
+
+         Rust
+
+`Implementation Status for all of the languages <status>`_
+
+Cookbooks
+---------
+
+.. grid::
+
+   .. grid-item::
+
+      .. button-link:: https://arrow.apache.org/cookbook/cpp/
+         :color: primary
+         :expand:
+
+         C++ cookbook
+
+   .. grid-item::
+
+      .. button-link:: https://arrow.apache.org/cookbook/java/
+         :color: primary
+         :expand:
+
+         Java cookbook
+
+   .. grid-item::
+
+      .. button-link:: https://arrow.apache.org/cookbook/py/
+         :color: primary
+         :expand:
+
+         Python cookbook
+
+   .. grid-item::
+
+      .. button-link:: https://arrow.apache.org/cookbook/r/
+         :color: primary
+         :expand:
+
+         R cookbook
+
+.. _toc.columnar:
+
+.. toctree::
+   :maxdepth: 2
+   :hidden:
+
+   format/index
+
+.. _toc.development:
+
+.. toctree::
+   :maxdepth: 2
+   :hidden:
+
+   developers/index
+

Review Comment:
   I totally agree with you and I like your proposal!
   
   Let me explain why we have decided to go with this layout. The pydata sphinx theme has a built-in dropdown list option in the top navigation bar. You can manipulate the exact location - that is, which item will be displayed as a dropdown (default is 5th I think, we selected 3rd). But it is always the last link in the top navbar!
   
   This dropdown gives us the option of having a separate side menu for each language ([see here](http://crossbow.voltrondata.com/pr_docs/36591/java/index.html)). We agreed it is a nice feature to have each language being displayed on its own in the sidebar.
   
   We were also thinking to put the implementations first in the top level navigation. But then all languages are listed together on the left side bar, even when you choose only the Java docs for example.
   
   I think adding examples on the top bar would be a nice idea!
   
   Also, I have added a PR to the pydata sphinx theme where we will be able to modify the name of the dropdown button in the top navigation bar.  It is now by default "More". Then we will be able to change it to "Implementations", or "Languages", or similar.
   



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] AlenkaF commented on pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "AlenkaF (via GitHub)" <gi...@apache.org>.
AlenkaF commented on PR #36591:
URL: https://github.com/apache/arrow/pull/36591#issuecomment-1643395264

   > Yes. I've pushed a fix. :-)
   
   Thank you @kou 🙏 


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] AlenkaF commented on pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "AlenkaF (via GitHub)" <gi...@apache.org>.
AlenkaF commented on PR #36591:
URL: https://github.com/apache/arrow/pull/36591#issuecomment-1628728665

   @github-actions crossbow submit preview-docs


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] AlenkaF commented on a diff in pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "AlenkaF (via GitHub)" <gi...@apache.org>.
AlenkaF commented on code in PR #36591:
URL: https://github.com/apache/arrow/pull/36591#discussion_r1324049159


##########
docs/source/_templates/docs-sidebar.html:
##########
@@ -1,25 +0,0 @@
-

Review Comment:
   The use of top bar navigation for the main three section is intentional. In the current version of the documentation, with all sections listed on the sidebar, it becomes very hard to navigate through as the list gets very long.
   
   It also gives us a follow-up option to nicely divide the subsections on the sidebar. If you, for example, look at the pydata sphinx theme page [here](https://pydata-sphinx-theme.readthedocs.io/en/latest/user_guide/index.html), you can see the sidebar items being nicely organised in sections in comparison to our list of pages on the current sidebar.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] github-actions[bot] commented on pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #36591:
URL: https://github.com/apache/arrow/pull/36591#issuecomment-1724816782

   Revision: 9ad62931bb40fa7a1aa75b5ab5488ba372fa4dd3
   
   Submitted crossbow builds: [ursacomputing/crossbow @ actions-11a232a768](https://github.com/ursacomputing/crossbow/branches/all?query=actions-11a232a768)
   
   |Task|Status|
   |----|------|
   |preview-docs|[![Github Actions](https://github.com/ursacomputing/crossbow/workflows/Crossbow/badge.svg?branch=actions-11a232a768-github-preview-docs)](https://github.com/ursacomputing/crossbow/actions/runs/6231158443/job/16912284911)|


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] danepitkin commented on a diff in pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "danepitkin (via GitHub)" <gi...@apache.org>.
danepitkin commented on code in PR #36591:
URL: https://github.com/apache/arrow/pull/36591#discussion_r1323284347


##########
docs/source/conf.py:
##########
@@ -319,7 +340,7 @@
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
 #
-html_logo = "_static/arrow.png"
+# html_logo = "_static/arrow.png"

Review Comment:
   Should we delete if commented out?



##########
docs/source/_templates/docs-sidebar.html:
##########
@@ -1,25 +0,0 @@
-

Review Comment:
   I actually really like the sidebar for navigation. Just an idea, but what if we move the items in the top bar (`Specifications and Protocols`, `Development`, etc.) back into the sidebar? I see the sup-options are still there once you click into the top level section.



##########
docs/source/index.rst:
##########
@@ -35,11 +37,216 @@ such topics as:
 **To learn how to use Arrow refer to the documentation specific to your
 target environment.**
 
+.. grid:: 2
+   :gutter: 4
+   :padding: 2 2 0 0
+   :class-container: sd-text-center
+
+   .. grid-item-card:: Format
+      :class-card: contrib-card
+      :shadow: none
+
+      Read about the Apache Arrow format
+      specifications and protocols.
+
+      +++
+
+      .. button-ref:: format
+         :ref-type: ref
+         :click-parent:
+         :color: primary
+         :expand:
+
+         To the specifications
+
+   .. grid-item-card:: Developing
+      :class-card: contrib-card
+      :shadow: none
+
+      Find the documentation on the topic of
+      contributions, reviews, building of the libraries
+      from source, building of the documentation, 
+      continuous integration, benchmarks and the
+      release process.
+
+      +++
+
+      .. button-ref:: developers
+         :ref-type: ref
+         :click-parent:
+         :color: primary
+         :expand:
+
+         To the documentation 
+
+Supported environments
+----------------------
+
+.. grid:: auto

Review Comment:
   For some reason, I find the lmplementations hard to read when they are in the same row vs in a separate row each. What do you think of moving them back to being list-like?



##########
docs/source/index.rst:
##########
@@ -35,11 +37,216 @@ such topics as:
 **To learn how to use Arrow refer to the documentation specific to your
 target environment.**
 
+.. grid:: 2
+   :gutter: 4
+   :padding: 2 2 0 0
+   :class-container: sd-text-center
+
+   .. grid-item-card:: Format
+      :class-card: contrib-card
+      :shadow: none
+
+      Read about the Apache Arrow format
+      specifications and protocols.
+
+      +++
+
+      .. button-ref:: format
+         :ref-type: ref
+         :click-parent:
+         :color: primary
+         :expand:
+
+         To the specifications
+
+   .. grid-item-card:: Developing
+      :class-card: contrib-card
+      :shadow: none
+
+      Find the documentation on the topic of
+      contributions, reviews, building of the libraries
+      from source, building of the documentation, 
+      continuous integration, benchmarks and the
+      release process.
+
+      +++
+
+      .. button-ref:: developers
+         :ref-type: ref
+         :click-parent:
+         :color: primary
+         :expand:
+
+         To the documentation 
+
+Supported environments
+----------------------
+
+.. grid:: auto
+
+   .. grid-item::
+
+      .. button-ref:: c-glib
+         :ref-type: ref
+         :color: info
+         :shadow:
+
+         C/GLib
+
+   .. grid-item::
+
+      .. button-ref:: cpp
+         :ref-type: ref
+         :color: info
+         :expand:
+
+         C++
+
+   .. grid-item::
+
+      .. button-link:: https://github.com/apache/arrow/blob/main/csharp/README.md
+         :color: info
+         :expand:
+
+         C#
+   
+   .. grid-item::
+
+      .. button-link:: https://pkg.go.dev/github.com/apache/arrow/go
+         :color: info
+         :expand:
+
+         Go
+
+   .. grid-item::
+
+      .. button-ref:: java
+         :ref-type: ref
+         :color: info
+         :expand:
+
+         Java
+
+   .. grid-item::
+
+      .. button-ref:: js
+         :ref-type: ref
+         :color: info
+         :expand:
+
+         JavaScript
+
+   .. grid-item::
+
+      .. button-link:: https://arrow.apache.org/julia/
+         :color: info
+         :expand:
+
+         Julia
+
+   .. grid-item::
+
+      .. button-link:: https://github.com/apache/arrow/blob/main/matlab/README.md
+         :ref-type: ref
+         :color: info
+         :expand:
+
+         Matlab
+
+   .. grid-item::
+
+      .. button-ref:: python
+         :ref-type: ref
+         :color: info
+         :expand:
+
+         Python
+
+   .. grid-item::
+
+      .. button-ref:: r
+         :ref-type: ref
+         :color: info
+         :expand:
+
+         R
+
+   .. grid-item::
+
+      .. button-link:: https://github.com/apache/arrow/blob/main/ruby/README.md
+         :color: info
+         :expand:
+
+         Ruby
+
+   .. grid-item::
+
+      .. button-link:: https://docs.rs/crate/arrow/
+         :color: info
+         :expand:
+
+         Rust
+
+`Implementation Status for all of the languages <status>`_
+
+Cookbooks
+---------
+
+.. grid::
+
+   .. grid-item::
+
+      .. button-link:: https://arrow.apache.org/cookbook/cpp/
+         :color: primary
+         :expand:
+
+         C++ cookbook
+
+   .. grid-item::
+
+      .. button-link:: https://arrow.apache.org/cookbook/java/
+         :color: primary
+         :expand:
+
+         Java cookbook
+
+   .. grid-item::
+
+      .. button-link:: https://arrow.apache.org/cookbook/py/
+         :color: primary
+         :expand:
+
+         Python cookbook
+
+   .. grid-item::
+
+      .. button-link:: https://arrow.apache.org/cookbook/r/
+         :color: primary
+         :expand:
+
+         R cookbook
+
+.. _toc.columnar:
+
+.. toctree::
+   :maxdepth: 2
+   :hidden:
+
+   format/index
+
+.. _toc.development:
+
+.. toctree::
+   :maxdepth: 2
+   :hidden:
+
+   developers/index
+

Review Comment:
   IMO I would like the top level navigation to display more than `Specifications and Protocols` and `Development`. I like how the current layout focuses on implementation/examples first before getting into the specifications and development. I think it would be best to optimize for a new user coming to the docs rather than a new contributor.
   
   My preference would be:
   1. `Implementations` (contains Implementation status + Languages)
   2. `Examples` (cookbooks)
   3. `Specifications` (specification and protocols)
   4. `Contributing` (development)
   
   I think https://grpc.io/docs/ is a similar example of what I am envisioning (which is another project with specification + multiple language implementations). Something clean, simple, and intuitive to navigate quickly.



##########
docs/source/index.rst:
##########
@@ -35,11 +37,216 @@ such topics as:
 **To learn how to use Arrow refer to the documentation specific to your
 target environment.**
 
+.. grid:: 2
+   :gutter: 4
+   :padding: 2 2 0 0
+   :class-container: sd-text-center
+
+   .. grid-item-card:: Format
+      :class-card: contrib-card
+      :shadow: none
+
+      Read about the Apache Arrow format
+      specifications and protocols.
+
+      +++
+
+      .. button-ref:: format
+         :ref-type: ref
+         :click-parent:
+         :color: primary
+         :expand:
+
+         To the specifications
+
+   .. grid-item-card:: Developing
+      :class-card: contrib-card
+      :shadow: none
+
+      Find the documentation on the topic of
+      contributions, reviews, building of the libraries
+      from source, building of the documentation, 
+      continuous integration, benchmarks and the
+      release process.
+
+      +++
+
+      .. button-ref:: developers
+         :ref-type: ref
+         :click-parent:
+         :color: primary
+         :expand:
+
+         To the documentation 
+
+Supported environments
+----------------------
+
+.. grid:: auto
+
+   .. grid-item::
+
+      .. button-ref:: c-glib
+         :ref-type: ref
+         :color: info
+         :shadow:

Review Comment:
   I'm personally not a fan of these buttons. The color and auto-sizing don't mesh with the existing theme well. I personally like the official support grid in https://grpc.io/docs/



##########
docs/source/conf.py:
##########
@@ -354,10 +375,9 @@
 
 # Custom sidebar templates, maps document names to template names.
 #
-html_sidebars = {
+# html_sidebars = {
 #    '**': ['sidebar-logo.html', 'sidebar-search-bs.html', 'sidebar-nav-bs.html'],
-    '**': ['docs-sidebar.html'],
-}
+# }

Review Comment:
   Should we delete here, too?



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] AlenkaF commented on pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "AlenkaF (via GitHub)" <gi...@apache.org>.
AlenkaF commented on PR #36591:
URL: https://github.com/apache/arrow/pull/36591#issuecomment-1722843145

   Last changes are in the top navbar where the dropdown is renamed from "More" to "Language implementations":
   
   ![Screenshot 2023-09-18 at 08 45 53](https://github.com/apache/arrow/assets/16418547/f4ffdc5e-ade8-460b-8e25-36a368371716)
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] AlenkaF commented on pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "AlenkaF (via GitHub)" <gi...@apache.org>.
AlenkaF commented on PR #36591:
URL: https://github.com/apache/arrow/pull/36591#issuecomment-1630729180

   ![Screenshot 2023-07-11 at 14 23 24](https://github.com/apache/arrow/assets/16418547/0e477669-28f4-4f9a-a7ff-039f2ad1d995)
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] AlenkaF commented on a diff in pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "AlenkaF (via GitHub)" <gi...@apache.org>.
AlenkaF commented on code in PR #36591:
URL: https://github.com/apache/arrow/pull/36591#discussion_r1258639548


##########
docs/source/conf.py:
##########
@@ -288,16 +288,34 @@
 # further.  For a list of options available for each theme, see the
 # documentation.
 #
+
 html_theme_options = {
-    "show_toc_level": 2,
     "use_edit_page_button": True,
+    "logo": {
+      "image_light": "_static/arrow.png",
+      "image_dark": "_static/arrow-dark.png",
+    },
+    "navbar_end": ["version-switcher", "theme-switcher", "navbar-icon-links"],

Review Comment:
   The default is `"navbar_end": ["navbar-icon-links"]` (https://pydata-sphinx-theme.readthedocs.io/en/latest/user_guide/layout.html#header-sections).



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] jorisvandenbossche merged pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.14.0

Posted by "jorisvandenbossche (via GitHub)" <gi...@apache.org>.
jorisvandenbossche merged PR #36591:
URL: https://github.com/apache/arrow/pull/36591


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] AlenkaF commented on pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "AlenkaF (via GitHub)" <gi...@apache.org>.
AlenkaF commented on PR #36591:
URL: https://github.com/apache/arrow/pull/36591#issuecomment-1630461419

   I have played around with the logo a bit because it is not clearly visible if located on the top navbar. It might make sense to keep it on the left side bar as is (see picture below).
   
   Regarding the navigation bar dropdown, the picture here is an example without extra index page for the supported environments section but using `header_links_before_dropdown` to organise all languages and cookbooks in a dropdown link named `More`. I find that it doesn't really make a difference though I like it better if the menu item is titled `Supported environments` and not `More`.
   
   ![Screenshot 2023-07-11 at 11 14 14](https://github.com/apache/arrow/assets/16418547/d1b1bce0-a468-4e5d-85d6-39fbfc0c067a)
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] jorisvandenbossche commented on a diff in pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "jorisvandenbossche (via GitHub)" <gi...@apache.org>.
jorisvandenbossche commented on code in PR #36591:
URL: https://github.com/apache/arrow/pull/36591#discussion_r1258430140


##########
docs/source/conf.py:
##########
@@ -288,16 +288,34 @@
 # further.  For a list of options available for each theme, see the
 # documentation.
 #
+
 html_theme_options = {
-    "show_toc_level": 2,
     "use_edit_page_button": True,
+    "logo": {
+      "image_light": "_static/arrow.png",
+      "image_dark": "_static/arrow-dark.png",
+    },
+    "navbar_end": ["version-switcher", "theme-switcher", "navbar-icon-links"],

Review Comment:
   How does this differ from the default?



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] 12rambau commented on pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "12rambau (via GitHub)" <gi...@apache.org>.
12rambau commented on PR #36591:
URL: https://github.com/apache/arrow/pull/36591#issuecomment-1631479750

   > I have played around with the logo a bit because it is not clearly visible if located on the top navbar. It might make sense to keep it on the left side bar as is (see picture below).
   
   If you needed another rational for not putting the logo in the left sidebar, it will be invisible on small screen where the left sidebar is hidden by default. I was just passing by, I'll see what we can do with @AlenkaF issue in the theme itself.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] github-actions[bot] commented on pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #36591:
URL: https://github.com/apache/arrow/pull/36591#issuecomment-1638122563

   Revision: 7073baa5d34b28b0d85769e4cf432eef9f055b80
   
   Submitted crossbow builds: [ursacomputing/crossbow @ actions-29c390fcf3](https://github.com/ursacomputing/crossbow/branches/all?query=actions-29c390fcf3)
   
   |Task|Status|
   |----|------|
   |preview-docs|[![Github Actions](https://github.com/ursacomputing/crossbow/workflows/Crossbow/badge.svg?branch=actions-29c390fcf3-github-preview-docs)](https://github.com/ursacomputing/crossbow/actions/runs/5576119062/jobs/10186940088)|


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] AlenkaF commented on pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "AlenkaF (via GitHub)" <gi...@apache.org>.
AlenkaF commented on PR #36591:
URL: https://github.com/apache/arrow/pull/36591#issuecomment-1700939792

   > Did you check locally that the versionwarnings are still working?
   
   No, didn't. Will do it as soon as I get the local setup displaying the warnings without this changes first =)


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] AlenkaF commented on pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "AlenkaF (via GitHub)" <gi...@apache.org>.
AlenkaF commented on PR #36591:
URL: https://github.com/apache/arrow/pull/36591#issuecomment-1717263549

   @github-actions crossbow submit preview-docs


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] AlenkaF commented on a diff in pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.14.0

Posted by "AlenkaF (via GitHub)" <gi...@apache.org>.
AlenkaF commented on code in PR #36591:
URL: https://github.com/apache/arrow/pull/36591#discussion_r1335713526


##########
docs/source/conf.py:
##########
@@ -288,16 +287,39 @@
 # further.  For a list of options available for each theme, see the
 # documentation.
 #
+
 html_theme_options = {
     "show_toc_level": 2,
     "use_edit_page_button": True,
+    "logo": {
+      "image_light": "_static/arrow.png",
+      "image_dark": "_static/arrow-dark.png",
+    },
+    "header_links_before_dropdown": 2,
+    "header_dropdown_text": "Language implementations",
+    "navbar_end": ["version-switcher", "theme-switcher", "navbar-icon-links"],
+    "icon_links": [
+        {
+            "name": "GitHub",
+            "url": "https://github.com/apache/arrow",
+            "icon": "fa-brands fa-square-github",
+        },
+        {
+            "name": "Twitter",
+            "url": "https://twitter.com/ApacheArrow",
+            "icon": "fa-brands fa-square-twitter",
+        },
+    ],
+    "show_version_warning_banner": True,
+    "switcher": {
+        # TODO: update versions.json on the arrow-site and change the link here
+        # "json_url": "/docs/_static/versions.json"
+        "json_url": "https://gist.githubusercontent.com/AlenkaF/9cc5820d3030cefcd2eee48e1ea58dc5/raw/3c0fa34dae3926f05958a5a7b3cfa8a07f0846d0/versions.json",

Review Comment:
   https://github.com/apache/arrow-site/pull/407



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] AlenkaF commented on a diff in pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.14.0

Posted by "AlenkaF (via GitHub)" <gi...@apache.org>.
AlenkaF commented on code in PR #36591:
URL: https://github.com/apache/arrow/pull/36591#discussion_r1335611490


##########
docs/source/conf.py:
##########
@@ -288,16 +287,39 @@
 # further.  For a list of options available for each theme, see the
 # documentation.
 #
+
 html_theme_options = {
     "show_toc_level": 2,
     "use_edit_page_button": True,
+    "logo": {
+      "image_light": "_static/arrow.png",
+      "image_dark": "_static/arrow-dark.png",
+    },
+    "header_links_before_dropdown": 2,
+    "header_dropdown_text": "Language implementations",
+    "navbar_end": ["version-switcher", "theme-switcher", "navbar-icon-links"],
+    "icon_links": [
+        {
+            "name": "GitHub",
+            "url": "https://github.com/apache/arrow",
+            "icon": "fa-brands fa-square-github",
+        },
+        {
+            "name": "Twitter",
+            "url": "https://twitter.com/ApacheArrow",
+            "icon": "fa-brands fa-square-twitter",
+        },
+    ],
+    "show_version_warning_banner": True,
+    "switcher": {
+        # TODO: update versions.json on the arrow-site and change the link here
+        # "json_url": "/docs/_static/versions.json"
+        "json_url": "https://gist.githubusercontent.com/AlenkaF/9cc5820d3030cefcd2eee48e1ea58dc5/raw/3c0fa34dae3926f05958a5a7b3cfa8a07f0846d0/versions.json",

Review Comment:
   That would be best, yes. Will open a PR on arrow-site.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] github-actions[bot] commented on pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #36591:
URL: https://github.com/apache/arrow/pull/36591#issuecomment-1635348244

   Revision: 125215b2db3de0e2cb7ab9fa36bf2a2f9b75a2c9
   
   Submitted crossbow builds: [ursacomputing/crossbow @ actions-4ab7e303d8](https://github.com/ursacomputing/crossbow/branches/all?query=actions-4ab7e303d8)
   
   |Task|Status|
   |----|------|
   |preview-docs|[![Github Actions](https://github.com/ursacomputing/crossbow/workflows/Crossbow/badge.svg?branch=actions-4ab7e303d8-github-preview-docs)](https://github.com/ursacomputing/crossbow/actions/runs/5551192524/jobs/10137062956)|


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] jorisvandenbossche commented on a diff in pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "jorisvandenbossche (via GitHub)" <gi...@apache.org>.
jorisvandenbossche commented on code in PR #36591:
URL: https://github.com/apache/arrow/pull/36591#discussion_r1259464054


##########
docs/source/conf.py:
##########
@@ -288,16 +288,34 @@
 # further.  For a list of options available for each theme, see the
 # documentation.
 #
+
 html_theme_options = {
-    "show_toc_level": 2,

Review Comment:
   I think it should influence the right-sidebar page TOC, by default it only shows the first level, and expands when scrolling down the page. With setting this, it should already show the first two levels by default (and then still further expands to more levels if those are present when scrolling)



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] AlenkaF commented on pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "AlenkaF (via GitHub)" <gi...@apache.org>.
AlenkaF commented on PR #36591:
URL: https://github.com/apache/arrow/pull/36591#issuecomment-1638384395

   I think this is ready for review now.
   
   @kou maybe you know what I can do to fix the two failing builds?
   https://github.com/apache/arrow/actions/runs/5576086006/jobs/10186861689?pr=36591
   https://github.com/apache/arrow/actions/runs/5576086006/jobs/10186861958?pr=36591
   
   @thisisnic @nealrichardson @rok in case you are interested to review the new look of our docs =)
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] kou commented on pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "kou (via GitHub)" <gi...@apache.org>.
kou commented on PR #36591:
URL: https://github.com/apache/arrow/pull/36591#issuecomment-1639641777

   > maybe you know what I can do to fix the two failing builds?
   https://github.com/apache/arrow/actions/runs/5576086006/jobs/10186861689?pr=36591
   https://github.com/apache/arrow/actions/runs/5576086006/jobs/10186861958?pr=36591
   
   Yes. I've pushed a fix. :-)
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] assignUser commented on pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "assignUser (via GitHub)" <gi...@apache.org>.
assignUser commented on PR #36591:
URL: https://github.com/apache/arrow/pull/36591#issuecomment-1646447872

   Looks neat! It is a bit jarring that the R docs are the only ones that are not a separate site but use a different theme... maybe we can convert those to using sphinx too? (a quick search revealed https://docs.ropensci.org/r2readthedocs/ as a potential solution for that?)


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] AlenkaF commented on a diff in pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "AlenkaF (via GitHub)" <gi...@apache.org>.
AlenkaF commented on code in PR #36591:
URL: https://github.com/apache/arrow/pull/36591#discussion_r1324129856


##########
docs/source/index.rst:
##########
@@ -35,11 +37,216 @@ such topics as:
 **To learn how to use Arrow refer to the documentation specific to your
 target environment.**
 
+.. grid:: 2
+   :gutter: 4
+   :padding: 2 2 0 0
+   :class-container: sd-text-center
+
+   .. grid-item-card:: Format
+      :class-card: contrib-card
+      :shadow: none
+
+      Read about the Apache Arrow format
+      specifications and protocols.
+
+      +++
+
+      .. button-ref:: format
+         :ref-type: ref
+         :click-parent:
+         :color: primary
+         :expand:
+
+         To the specifications
+
+   .. grid-item-card:: Developing
+      :class-card: contrib-card
+      :shadow: none
+
+      Find the documentation on the topic of
+      contributions, reviews, building of the libraries
+      from source, building of the documentation, 
+      continuous integration, benchmarks and the
+      release process.
+
+      +++
+
+      .. button-ref:: developers
+         :ref-type: ref
+         :click-parent:
+         :color: primary
+         :expand:
+
+         To the documentation 
+
+Supported environments
+----------------------
+
+.. grid:: auto
+
+   .. grid-item::
+
+      .. button-ref:: c-glib
+         :ref-type: ref
+         :color: info
+         :shadow:

Review Comment:
   I removed the buttons altogether - they really weren't the best idea :)



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] AlenkaF commented on pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "AlenkaF (via GitHub)" <gi...@apache.org>.
AlenkaF commented on PR #36591:
URL: https://github.com/apache/arrow/pull/36591#issuecomment-1724804289

   Oh, I see they just cut the release 4 days ago! This is great news 🎉  (We have been pinning to the dev version of 0.14.0)
   Thank you for the ping @kou, will use the latest version (0.14.0) now 👍 


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] AlenkaF commented on pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "AlenkaF (via GitHub)" <gi...@apache.org>.
AlenkaF commented on PR #36591:
URL: https://github.com/apache/arrow/pull/36591#issuecomment-1709543549

   @github-actions crossbow submit preview-docs


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] AlenkaF commented on pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "AlenkaF (via GitHub)" <gi...@apache.org>.
AlenkaF commented on PR #36591:
URL: https://github.com/apache/arrow/pull/36591#issuecomment-1709957540

   @github-actions crossbow submit preview-docs


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] jorisvandenbossche commented on pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.14.0

Posted by "jorisvandenbossche (via GitHub)" <gi...@apache.org>.
jorisvandenbossche commented on PR #36591:
URL: https://github.com/apache/arrow/pull/36591#issuecomment-1737500504

   OK, let's give this a go on the development docs, so we still have some time to fine tune before the 14.0 release. Thanks a lot Alenka!


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] danepitkin commented on a diff in pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "danepitkin (via GitHub)" <gi...@apache.org>.
danepitkin commented on code in PR #36591:
URL: https://github.com/apache/arrow/pull/36591#discussion_r1323324014


##########
docs/source/index.rst:
##########
@@ -35,11 +37,216 @@ such topics as:
 **To learn how to use Arrow refer to the documentation specific to your
 target environment.**
 
+.. grid:: 2
+   :gutter: 4
+   :padding: 2 2 0 0
+   :class-container: sd-text-center
+
+   .. grid-item-card:: Format
+      :class-card: contrib-card
+      :shadow: none
+
+      Read about the Apache Arrow format
+      specifications and protocols.
+
+      +++
+
+      .. button-ref:: format
+         :ref-type: ref
+         :click-parent:
+         :color: primary
+         :expand:
+
+         To the specifications
+
+   .. grid-item-card:: Developing
+      :class-card: contrib-card
+      :shadow: none
+
+      Find the documentation on the topic of
+      contributions, reviews, building of the libraries
+      from source, building of the documentation, 
+      continuous integration, benchmarks and the
+      release process.
+
+      +++
+
+      .. button-ref:: developers
+         :ref-type: ref
+         :click-parent:
+         :color: primary
+         :expand:
+
+         To the documentation 
+
+Supported environments
+----------------------
+
+.. grid:: auto
+
+   .. grid-item::
+
+      .. button-ref:: c-glib
+         :ref-type: ref
+         :color: info
+         :shadow:
+
+         C/GLib
+
+   .. grid-item::
+
+      .. button-ref:: cpp
+         :ref-type: ref
+         :color: info
+         :expand:
+
+         C++
+
+   .. grid-item::
+
+      .. button-link:: https://github.com/apache/arrow/blob/main/csharp/README.md
+         :color: info
+         :expand:
+
+         C#
+   
+   .. grid-item::
+
+      .. button-link:: https://pkg.go.dev/github.com/apache/arrow/go
+         :color: info
+         :expand:
+
+         Go
+
+   .. grid-item::
+
+      .. button-ref:: java
+         :ref-type: ref
+         :color: info
+         :expand:
+
+         Java
+
+   .. grid-item::
+
+      .. button-ref:: js
+         :ref-type: ref
+         :color: info
+         :expand:
+
+         JavaScript
+
+   .. grid-item::
+
+      .. button-link:: https://arrow.apache.org/julia/
+         :color: info
+         :expand:
+
+         Julia
+
+   .. grid-item::
+
+      .. button-link:: https://github.com/apache/arrow/blob/main/matlab/README.md
+         :ref-type: ref
+         :color: info
+         :expand:
+
+         Matlab
+
+   .. grid-item::
+
+      .. button-ref:: python
+         :ref-type: ref
+         :color: info
+         :expand:
+
+         Python
+
+   .. grid-item::
+
+      .. button-ref:: r
+         :ref-type: ref
+         :color: info
+         :expand:
+
+         R
+
+   .. grid-item::
+
+      .. button-link:: https://github.com/apache/arrow/blob/main/ruby/README.md
+         :color: info
+         :expand:
+
+         Ruby
+
+   .. grid-item::
+
+      .. button-link:: https://docs.rs/crate/arrow/
+         :color: info
+         :expand:
+
+         Rust
+
+`Implementation Status for all of the languages <status>`_

Review Comment:
   This link is broken for me



##########
docs/source/index.rst:
##########
@@ -35,11 +37,216 @@ such topics as:
 **To learn how to use Arrow refer to the documentation specific to your
 target environment.**
 
+.. grid:: 2
+   :gutter: 4
+   :padding: 2 2 0 0
+   :class-container: sd-text-center
+
+   .. grid-item-card:: Format
+      :class-card: contrib-card
+      :shadow: none
+
+      Read about the Apache Arrow format
+      specifications and protocols.
+
+      +++
+
+      .. button-ref:: format
+         :ref-type: ref
+         :click-parent:
+         :color: primary
+         :expand:
+
+         To the specifications
+
+   .. grid-item-card:: Developing
+      :class-card: contrib-card
+      :shadow: none
+
+      Find the documentation on the topic of
+      contributions, reviews, building of the libraries
+      from source, building of the documentation, 
+      continuous integration, benchmarks and the
+      release process.
+
+      +++
+
+      .. button-ref:: developers
+         :ref-type: ref
+         :click-parent:
+         :color: primary
+         :expand:
+
+         To the documentation 
+
+Supported environments

Review Comment:
   I would prefer to see the landing page focus on "Getting Started" first, "Language Implementations" second, "Examples" third, "Specification" fourth, and "Contributing" fifth. Essentially, I think we should optimize for users over contributors/developers.



##########
docs/source/cpp/index.rst:
##########
@@ -27,7 +29,7 @@ Welcome to the Apache Arrow C++ implementation documentation!
 
    .. grid-item-card:: Basic understanding

Review Comment:
   Optional: I know this is not part of your diff, but I would prefer to see the grid item match the section name. e.g. `Basic understanding` -> `Getting started`, `Examples of use` -> `Examples`. The "button" inside the box could say `to Getting Started` and `to Examples` (or just remove it if that's preferred)



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] github-actions[bot] commented on pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #36591:
URL: https://github.com/apache/arrow/pull/36591#issuecomment-1628732810

   Revision: 67c8e5ed3d95b51d6b856c2d4cb06681f6a54612
   
   Submitted crossbow builds: [ursacomputing/crossbow @ actions-12e0914bc0](https://github.com/ursacomputing/crossbow/branches/all?query=actions-12e0914bc0)
   
   |Task|Status|
   |----|------|
   |preview-docs|[![Github Actions](https://github.com/ursacomputing/crossbow/workflows/Crossbow/badge.svg?branch=actions-12e0914bc0-github-preview-docs)](https://github.com/ursacomputing/crossbow/actions/runs/5507360900/jobs/10037217486)|


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] AlenkaF commented on pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "AlenkaF (via GitHub)" <gi...@apache.org>.
AlenkaF commented on PR #36591:
URL: https://github.com/apache/arrow/pull/36591#issuecomment-1632253339

   Regarding the custom colors in our `theme_overrides.css`
   https://github.com/apache/arrow/blob/63644f41102657efe7c51b04e42e050374366800/docs/source/_static/theme_overrides.css#L24-L31
   
   The css color styles used currently are quite different then what the theme used before, see [color variables for version 0.8](https://pydata-sphinx-theme.readthedocs.io/en/v0.8.1/user_guide/customizing.html#css-theme-variables) vs [new color variables structure](https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/styling.html#color-variables).
   
   Currently the theme uses primary and secondary theme colors that are meant to complement one another visually across the whole theme (light and dark separately) plus some extra like "info", "warning", "success", ... but much less then in the old version of the theme.
   
   Comparing the custom colors we have set in Apache Arrow to the colors in the new theme:
   
   - active navigation is red `rgb(215, 70, 51)` in our custom css and is light blue / primary `rgb(69, 157, 185)` in the new pydata sphinx theme
   - link hover is is also red `rgb(215, 70, 51)` currently and is orange/secondary `rgb(238, 144, 64)` in the new theme
   - I am not sure about the headerlink color. It is also defined to red currently, but am not sure how to match it with the new theme
   - h1 and h2 color is black `rgb(51, 51, 51)` currently and is light blue / primary` rgb(69, 157, 185)` in the new pydata sphinx theme
   - info color is light blue `rgb(23, 162, 184)` currently and is almost identical to the primary light blue `rgb(69, 157, 185)` in the new theme 
   
   What I suggest is to remove all css variables from our custom css and maybe change the secondary theme color to our current red `rgb(215, 70, 51)`.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] github-actions[bot] commented on pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #36591:
URL: https://github.com/apache/arrow/pull/36591#issuecomment-1630730523

   Revision: 8b40a3e10c0baed9516c5a2ce1d9aed4c030970e
   
   Submitted crossbow builds: [ursacomputing/crossbow @ actions-21674461bf](https://github.com/ursacomputing/crossbow/branches/all?query=actions-21674461bf)
   
   |Task|Status|
   |----|------|
   |preview-docs|[![Github Actions](https://github.com/ursacomputing/crossbow/workflows/Crossbow/badge.svg?branch=actions-21674461bf-github-preview-docs)](https://github.com/ursacomputing/crossbow/actions/runs/5519883100/jobs/10065742834)|


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] AlenkaF commented on a diff in pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "AlenkaF (via GitHub)" <gi...@apache.org>.
AlenkaF commented on code in PR #36591:
URL: https://github.com/apache/arrow/pull/36591#discussion_r1258636055


##########
docs/source/conf.py:
##########
@@ -288,16 +288,34 @@
 # further.  For a list of options available for each theme, see the
 # documentation.
 #
+
 html_theme_options = {
-    "show_toc_level": 2,

Review Comment:
   I tested it without and found no difference. But might be missing something.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] jorisvandenbossche commented on pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "jorisvandenbossche (via GitHub)" <gi...@apache.org>.
jorisvandenbossche commented on PR #36591:
URL: https://github.com/apache/arrow/pull/36591#issuecomment-1635346034

   @github-actions crossbow submit preview-docs


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] kou commented on pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "kou (via GitHub)" <gi...@apache.org>.
kou commented on PR #36591:
URL: https://github.com/apache/arrow/pull/36591#issuecomment-1724869067

   Could you update "0.13" in this PR title and the related issue title?


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] AlenkaF commented on pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "AlenkaF (via GitHub)" <gi...@apache.org>.
AlenkaF commented on PR #36591:
URL: https://github.com/apache/arrow/pull/36591#issuecomment-1724815222

   @github-actions crossbow submit preview-docs


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] jorisvandenbossche commented on a diff in pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.14.0

Posted by "jorisvandenbossche (via GitHub)" <gi...@apache.org>.
jorisvandenbossche commented on code in PR #36591:
URL: https://github.com/apache/arrow/pull/36591#discussion_r1335577515


##########
docs/source/conf.py:
##########
@@ -288,16 +287,39 @@
 # further.  For a list of options available for each theme, see the
 # documentation.
 #
+
 html_theme_options = {
     "show_toc_level": 2,
     "use_edit_page_button": True,
+    "logo": {
+      "image_light": "_static/arrow.png",
+      "image_dark": "_static/arrow-dark.png",
+    },
+    "header_links_before_dropdown": 2,
+    "header_dropdown_text": "Language implementations",
+    "navbar_end": ["version-switcher", "theme-switcher", "navbar-icon-links"],
+    "icon_links": [
+        {
+            "name": "GitHub",
+            "url": "https://github.com/apache/arrow",
+            "icon": "fa-brands fa-square-github",
+        },
+        {
+            "name": "Twitter",
+            "url": "https://twitter.com/ApacheArrow",
+            "icon": "fa-brands fa-square-twitter",
+        },
+    ],
+    "show_version_warning_banner": True,
+    "switcher": {
+        # TODO: update versions.json on the arrow-site and change the link here
+        # "json_url": "/docs/_static/versions.json"
+        "json_url": "https://gist.githubusercontent.com/AlenkaF/9cc5820d3030cefcd2eee48e1ea58dc5/raw/3c0fa34dae3926f05958a5a7b3cfa8a07f0846d0/versions.json",

Review Comment:
   This needs to be updated before merging this PR?



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] AlenkaF commented on a diff in pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "AlenkaF (via GitHub)" <gi...@apache.org>.
AlenkaF commented on code in PR #36591:
URL: https://github.com/apache/arrow/pull/36591#discussion_r1311439859


##########
docs/source/format/index.rst:
##########
@@ -15,10 +15,13 @@
 .. specific language governing permissions and limitations
 .. under the License.
 
+.. _format:
+
+Specifications and Protocols
+============================
+
 .. toctree::
    :maxdepth: 2
-   :caption: Specifications and Protocols

Review Comment:
   Yes, and also in the toctree:
   
   ![Screenshot 2023-08-31 at 12 33 40](https://github.com/apache/arrow/assets/16418547/4dd2062e-2a1a-4ea2-b0f4-ecec569a577c)
   
   vs.
   
   ![Screenshot 2023-08-31 at 12 37 44](https://github.com/apache/arrow/assets/16418547/bde68f19-6f15-4d7a-bf9f-860c50b53ef8)
   



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] AlenkaF commented on pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "AlenkaF (via GitHub)" <gi...@apache.org>.
AlenkaF commented on PR #36591:
URL: https://github.com/apache/arrow/pull/36591#issuecomment-1700937076

   @github-actions crossbow submit preview-docs


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] jorisvandenbossche commented on a diff in pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "jorisvandenbossche (via GitHub)" <gi...@apache.org>.
jorisvandenbossche commented on code in PR #36591:
URL: https://github.com/apache/arrow/pull/36591#discussion_r1311444562


##########
docs/source/format/index.rst:
##########
@@ -15,10 +15,13 @@
 .. specific language governing permissions and limitations
 .. under the License.
 
+.. _format:
+
+Specifications and Protocols
+============================
+
 .. toctree::
    :maxdepth: 2
-   :caption: Specifications and Protocols

Review Comment:
   OK, that's a good change then ;)



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] AlenkaF commented on a diff in pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "AlenkaF (via GitHub)" <gi...@apache.org>.
AlenkaF commented on code in PR #36591:
URL: https://github.com/apache/arrow/pull/36591#discussion_r1311391791


##########
docs/source/developers/contributing.rst:
##########
@@ -1,190 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one
-.. or more contributor license agreements.  See the NOTICE file
-.. distributed with this work for additional information
-.. regarding copyright ownership.  The ASF licenses this file
-.. to you under the Apache License, Version 2.0 (the
-.. "License"); you may not use this file except in compliance
-.. with the License.  You may obtain a copy of the License at
-
-..   http://www.apache.org/licenses/LICENSE-2.0
-
-.. Unless required by applicable law or agreed to in writing,
-.. software distributed under the License is distributed on an
-.. "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-.. KIND, either express or implied.  See the License for the
-.. specific language governing permissions and limitations
-.. under the License.
-
-.. highlight:: console
-
-.. _contributing:
-
-****************************
-Contributing to Apache Arrow
-****************************
-
-**Thanks for your interest in the Apache Arrow project.**

Review Comment:
   Yes. The only change is in the order of the sections: on the index page "Connection to the specific language development pages" comes first, in the contributing.rst it came last.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] AlenkaF commented on a diff in pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "AlenkaF (via GitHub)" <gi...@apache.org>.
AlenkaF commented on code in PR #36591:
URL: https://github.com/apache/arrow/pull/36591#discussion_r1259654906


##########
docs/source/conf.py:
##########
@@ -288,16 +288,34 @@
 # further.  For a list of options available for each theme, see the
 # documentation.
 #
+
 html_theme_options = {
-    "show_toc_level": 2,

Review Comment:
   [8b40a3e](https://github.com/apache/arrow/pull/36591/commits/8b40a3e10c0baed9516c5a2ce1d9aed4c030970e)



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] jorisvandenbossche commented on a diff in pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "jorisvandenbossche (via GitHub)" <gi...@apache.org>.
jorisvandenbossche commented on code in PR #36591:
URL: https://github.com/apache/arrow/pull/36591#discussion_r1258421448


##########
docs/source/conf.py:
##########
@@ -288,16 +288,34 @@
 # further.  For a list of options available for each theme, see the
 # documentation.
 #
+
 html_theme_options = {
-    "show_toc_level": 2,

Review Comment:
   This could be kept?



##########
docs/source/_static/theme_overrides.css:
##########
@@ -50,14 +49,13 @@ code {
 a.navbar-brand img {
   height: auto;
   width: auto;
-  max-height: 15vh;
+  max-height: var(--pst-header-height);
   max-width: 100%;
 }

Review Comment:
   Probably this whole section (and the `.navbar-brand` above) can be removed, as it was previously only needed because we put this section in the sidebar instead of navbar. Now the logo is in the normal location as the theme expects, so I would assume no custom css is needed (at least to start with)



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] AlenkaF commented on a diff in pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "AlenkaF (via GitHub)" <gi...@apache.org>.
AlenkaF commented on code in PR #36591:
URL: https://github.com/apache/arrow/pull/36591#discussion_r1259653139


##########
docs/source/conf.py:
##########
@@ -288,16 +288,34 @@
 # further.  For a list of options available for each theme, see the
 # documentation.
 #
+
 html_theme_options = {
-    "show_toc_level": 2,

Review Comment:
   OK, I see it now ([this section for example](http://crossbow.voltrondata.com/pr_docs/36591/developers/guide/index.html)).
   Will put it back in the next commit (accidentally removed it twice).
   
   
   
   



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] AlenkaF commented on pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "AlenkaF (via GitHub)" <gi...@apache.org>.
AlenkaF commented on PR #36591:
URL: https://github.com/apache/arrow/pull/36591#issuecomment-1631890097

   Thank you @12rambau for the information about the left sidebar and the issue in the theme (more of a feature request really)!
   Regarding the logo, we increased the header height and it works very well 👍 


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] AlenkaF commented on pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "AlenkaF (via GitHub)" <gi...@apache.org>.
AlenkaF commented on PR #36591:
URL: https://github.com/apache/arrow/pull/36591#issuecomment-1628733161

   ![Screenshot 2023-07-10 at 13 09 58](https://github.com/apache/arrow/assets/16418547/62506dd0-4edd-4d2f-912f-f40d812771f4)
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] thisisnic commented on pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "thisisnic (via GitHub)" <gi...@apache.org>.
thisisnic commented on PR #36591:
URL: https://github.com/apache/arrow/pull/36591#issuecomment-1647552094

   > Thanks for looking at it Jacob! From the technical perspective I think it is a good idea to research. But I am not sure how would that affect the R team. @thisisnic @paleolimbot what is your opinion on having the R docs converted to use Sphinx?
   
   I am strongly opposed to it.  It would make the R docs inconsistent with other R package docs which don't tend to use Sphinx, so ultimately make things worse for R users. It would also reduce maintainability, given it would be a new framework to learn, and so also make it harder for new contributors to get involved.  


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] nealrichardson commented on pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "nealrichardson (via GitHub)" <gi...@apache.org>.
nealrichardson commented on PR #36591:
URL: https://github.com/apache/arrow/pull/36591#issuecomment-1648152415

   Agree with Nic. 
   
   We've previously added CSS to better match the arrow site, can do that again. 


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] assignUser commented on pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "assignUser (via GitHub)" <gi...@apache.org>.
assignUser commented on PR #36591:
URL: https://github.com/apache/arrow/pull/36591#issuecomment-1650900062

   I retract my request and also agree with Nic after considering it. (was more a spur of the moment comment, the difference was jarringly bright as sphinx seems to auto detect dark mode and adjust the theme while our pkgdown theme does not ^^)


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] github-actions[bot] commented on pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #36591:
URL: https://github.com/apache/arrow/pull/36591#issuecomment-1717267700

   Revision: 803a336b8e7410d158cfa45e4042493230a48fe7
   
   Submitted crossbow builds: [ursacomputing/crossbow @ actions-6cc26701ba](https://github.com/ursacomputing/crossbow/branches/all?query=actions-6cc26701ba)
   
   |Task|Status|
   |----|------|
   |preview-docs|[![Github Actions](https://github.com/ursacomputing/crossbow/workflows/Crossbow/badge.svg?branch=actions-6cc26701ba-github-preview-docs)](https://github.com/ursacomputing/crossbow/actions/runs/6170531225/job/16746971530)|


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] AlenkaF commented on pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "AlenkaF (via GitHub)" <gi...@apache.org>.
AlenkaF commented on PR #36591:
URL: https://github.com/apache/arrow/pull/36591#issuecomment-1683386552

   @github-actions crossbow submit preview-docs


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] github-actions[bot] commented on pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #36591:
URL: https://github.com/apache/arrow/pull/36591#issuecomment-1683388289

   Revision: fb08d5c318d560fcdf6908713ea376dc5a740742
   
   Submitted crossbow builds: [ursacomputing/crossbow @ actions-f7bf65762e](https://github.com/ursacomputing/crossbow/branches/all?query=actions-f7bf65762e)
   
   |Task|Status|
   |----|------|
   |preview-docs|[![Github Actions](https://github.com/ursacomputing/crossbow/workflows/Crossbow/badge.svg?branch=actions-f7bf65762e-github-preview-docs)](https://github.com/ursacomputing/crossbow/actions/runs/5899281142/job/16001545899)|


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] AlenkaF commented on pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "AlenkaF (via GitHub)" <gi...@apache.org>.
AlenkaF commented on PR #36591:
URL: https://github.com/apache/arrow/pull/36591#issuecomment-1713494227

   I have applied code review suggestions and changed the way we display version warnings so that now we use built-in functionality of the pydata sphinx theme.
   
   Preview of the latest changes can be found here: http://crossbow.voltrondata.com/pr_docs/36591/
   
   Would somebody be willing to review this PR as Joris is not available for a while now? @raulcd @assignUser @danepitkin


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] kou commented on pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "kou (via GitHub)" <gi...@apache.org>.
kou commented on PR #36591:
URL: https://github.com/apache/arrow/pull/36591#issuecomment-1724485743

   FYI: We may want to use PyData Sphinx Theme 0.14.0 not 0.13.0 because 0.13.0 has a version switcher problem on mobile:
   * https://github.com/pydata/pydata-sphinx-theme/issues/1340
   * https://github.com/pydata/pydata-sphinx-theme/pull/1342


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] AlenkaF commented on a diff in pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.14.0

Posted by "AlenkaF (via GitHub)" <gi...@apache.org>.
AlenkaF commented on code in PR #36591:
URL: https://github.com/apache/arrow/pull/36591#discussion_r1335611490


##########
docs/source/conf.py:
##########
@@ -288,16 +287,39 @@
 # further.  For a list of options available for each theme, see the
 # documentation.
 #
+
 html_theme_options = {
     "show_toc_level": 2,
     "use_edit_page_button": True,
+    "logo": {
+      "image_light": "_static/arrow.png",
+      "image_dark": "_static/arrow-dark.png",
+    },
+    "header_links_before_dropdown": 2,
+    "header_dropdown_text": "Language implementations",
+    "navbar_end": ["version-switcher", "theme-switcher", "navbar-icon-links"],
+    "icon_links": [
+        {
+            "name": "GitHub",
+            "url": "https://github.com/apache/arrow",
+            "icon": "fa-brands fa-square-github",
+        },
+        {
+            "name": "Twitter",
+            "url": "https://twitter.com/ApacheArrow",
+            "icon": "fa-brands fa-square-twitter",
+        },
+    ],
+    "show_version_warning_banner": True,
+    "switcher": {
+        # TODO: update versions.json on the arrow-site and change the link here
+        # "json_url": "/docs/_static/versions.json"
+        "json_url": "https://gist.githubusercontent.com/AlenkaF/9cc5820d3030cefcd2eee48e1ea58dc5/raw/3c0fa34dae3926f05958a5a7b3cfa8a07f0846d0/versions.json",

Review Comment:
   That would be best, yes. Can open a PR on arrow-site.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] jorisvandenbossche commented on pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "jorisvandenbossche (via GitHub)" <gi...@apache.org>.
jorisvandenbossche commented on PR #36591:
URL: https://github.com/apache/arrow/pull/36591#issuecomment-1700564429

   One small detail that I noticed. I find the new code highlighting is a bit strange (example from https://arrow.apache.org/docs/cpp/parquet.html#filereader)
   
   ![image](https://github.com/apache/arrow/assets/1020496/ad56aeda-999a-4d63-8e9c-dffd3cf51b39)
   
   vs
   
   ![image](https://github.com/apache/arrow/assets/1020496/477225a4-e7ff-4076-8e07-c4be1b9f6393)
   
   I liked the old color better, I think (clearer that it is highlighting some lines)
   
   But I assume that's just something from pygments that we might not want to start customizing.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] jorisvandenbossche commented on a diff in pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "jorisvandenbossche (via GitHub)" <gi...@apache.org>.
jorisvandenbossche commented on code in PR #36591:
URL: https://github.com/apache/arrow/pull/36591#discussion_r1311221570


##########
docs/source/_static/theme_overrides.css:
##########
@@ -70,17 +44,17 @@ a.navbar-brand img {
 .contrib-card .sd-card-img-top {
   margin: 2px;
   height: 75px;
+  background: none !important;
 }
 
 .contrib-card .sd-card-title {
-  /* color: rgb(var(--pst-color-h1)) !important; */
+  color: var(--pst-color-primary);
   font-size: var(--pst-font-size-h3);
-  /* font-weight: bold; */
   padding: 1rem 0rem 0.5rem 0rem;
 }
 
 .contrib-card .sd-card-footer {
-  border: none;
+  border: none !important;
 }
 
 .contib-card .sd-card-footer p.sd-card-text{

Review Comment:
   Also not sure if this is still doing something (I also don't seem to get any effect when removing it)



##########
ci/conda_env_sphinx.txt:
##########
@@ -20,7 +20,6 @@ breathe
 doxygen
 ipython
 numpydoc
-pydata-sphinx-theme==0.8

Review Comment:
   Small nitpick, but maybe leave it here but commented out (and then we can add a comment about it currently requiring the latest unreleased version)



##########
docs/source/_static/theme_overrides.css:
##########
@@ -21,43 +21,17 @@
 /* Customizing with theme CSS variables */
 
 :root {
-  --pst-color-active-navigation: 215, 70, 51;
-  --pst-color-link-hover: 215, 70, 51;
-  --pst-color-headerlink: 215, 70, 51;
-  /* Use normal text color (like h3, ..) instead of primary color */
-  --pst-color-h1: var(--color-text-base);
-  --pst-color-h2: var(--color-text-base);
-  /* Use softer blue from bootstrap's default info color */
-  --pst-color-info: 23, 162, 184;
-  --pst-header-height: 0px;
-}
-
-code {
-  color: rgb(215, 70, 51);
+  --pst-header-height: 6rem;
+  --pst-font-weight-heading: 600;

Review Comment:
   Out of curiosity, this is just for stylistic reasons? 



##########
docs/source/developers/contributing.rst:
##########
@@ -1,190 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one
-.. or more contributor license agreements.  See the NOTICE file
-.. distributed with this work for additional information
-.. regarding copyright ownership.  The ASF licenses this file
-.. to you under the Apache License, Version 2.0 (the
-.. "License"); you may not use this file except in compliance
-.. with the License.  You may obtain a copy of the License at
-
-..   http://www.apache.org/licenses/LICENSE-2.0
-
-.. Unless required by applicable law or agreed to in writing,
-.. software distributed under the License is distributed on an
-.. "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-.. KIND, either express or implied.  See the License for the
-.. specific language governing permissions and limitations
-.. under the License.
-
-.. highlight:: console
-
-.. _contributing:
-
-****************************
-Contributing to Apache Arrow
-****************************
-
-**Thanks for your interest in the Apache Arrow project.**

Review Comment:
   The content of this file is just completely copied to index.rst, right? (so don't have to review it in detail)



##########
docs/source/python/index.rst:
##########
@@ -62,3 +67,8 @@ files into Arrow structures.
    api
    getting_involved
    benchmarks
+
+.. toctree::
+   :maxdepth: 2
+
+   Python cookbook <https://arrow.apache.org/cookbook/py/>

Review Comment:
   Can this also be added as last item in the toctree above?



##########
docs/source/format/index.rst:
##########
@@ -15,10 +15,13 @@
 .. specific language governing permissions and limitations
 .. under the License.
 
+.. _format:
+
+Specifications and Protocols
+============================
+
 .. toctree::
    :maxdepth: 2
-   :caption: Specifications and Protocols

Review Comment:
   Out of curiosity, what happens if you keep this caption? Does it then appear in the sidebar (between the standard "Section Navigation" and the actual content)



##########
docs/source/_static/theme_overrides.css:
##########
@@ -21,43 +21,17 @@
 /* Customizing with theme CSS variables */
 
 :root {
-  --pst-color-active-navigation: 215, 70, 51;
-  --pst-color-link-hover: 215, 70, 51;
-  --pst-color-headerlink: 215, 70, 51;
-  /* Use normal text color (like h3, ..) instead of primary color */
-  --pst-color-h1: var(--color-text-base);
-  --pst-color-h2: var(--color-text-base);
-  /* Use softer blue from bootstrap's default info color */
-  --pst-color-info: 23, 162, 184;
-  --pst-header-height: 0px;
-}
-
-code {
-  color: rgb(215, 70, 51);
+  --pst-header-height: 6rem;
+  --pst-font-weight-heading: 600;
 }
 
 .footer {
   text-align: center;
 }

Review Comment:
   Not sure if this is still doing anything? (I don't see anything change when I remove it in firefox dev tools, and also our footer text is not actually centered, which I think is fine)



##########
docs/source/index.rst:
##########
@@ -35,11 +37,216 @@ such topics as:
 **To learn how to use Arrow refer to the documentation specific to your
 target environment.**
 
+.. grid:: 2

Review Comment:
   Nice start for a home page!



##########
docs/source/_static/theme_overrides.css:
##########
@@ -21,43 +21,17 @@
 /* Customizing with theme CSS variables */
 
 :root {
-  --pst-color-active-navigation: 215, 70, 51;
-  --pst-color-link-hover: 215, 70, 51;
-  --pst-color-headerlink: 215, 70, 51;
-  /* Use normal text color (like h3, ..) instead of primary color */
-  --pst-color-h1: var(--color-text-base);
-  --pst-color-h2: var(--color-text-base);
-  /* Use softer blue from bootstrap's default info color */
-  --pst-color-info: 23, 162, 184;
-  --pst-header-height: 0px;
-}
-
-code {
-  color: rgb(215, 70, 51);
+  --pst-header-height: 6rem;

Review Comment:
   Maybe add a comment that this is done to make the logo a bit larger (so we remember later)



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] AlenkaF commented on pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "AlenkaF (via GitHub)" <gi...@apache.org>.
AlenkaF commented on PR #36591:
URL: https://github.com/apache/arrow/pull/36591#issuecomment-1708533789

   I had some issues displaying the version warnings on the newly built docs from this PR when testing locally. Instead of spending more time debugging I decided to test a new feature in the development version of the pydata sphinx theme. A PR has been merged in July adding a version warning bar: https://github.com/pydata/pydata-sphinx-theme/pull/1354.
   
   It is a bit different from what we currently have. The difference is that in our current case we display a separate warning for developer docs pointing to the development version as the preferred one.
   
   But the version warnings bar in the pydata sphinx theme is nicer IMO and it makes our code much much easier to maintain.
   
   I am adding two images to show the difference between the current version warnings bar we have and the version warnings bar included in the theme:
   
   
   ![Screenshot 2023-09-06 at 15 48 59](https://github.com/apache/arrow/assets/16418547/3cec16f6-8eab-4acd-b120-88b144546e18)
   
   
   ![Screenshot 2023-09-06 at 15 48 54](https://github.com/apache/arrow/assets/16418547/ef877309-d58b-44bf-9ed5-3bb79ffadf0a)
   
   
   I prefer the latter (pydata sphinx theme version warning bar).


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] jorisvandenbossche commented on pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "jorisvandenbossche (via GitHub)" <gi...@apache.org>.
jorisvandenbossche commented on PR #36591:
URL: https://github.com/apache/arrow/pull/36591#issuecomment-1630485457

   > Regarding the navigation bar dropdown, the picture here is an example without extra index page for the supported environments section but using `header_links_before_dropdown` to organise all languages and cookbooks in a dropdown link named `More`. I find that it doesn't really make a difference though I like it better if the menu item is titled `Supported environments` and not `More`.
   
   Yes, if we do this, we should certainly ensure we can call it something more informative than "More". But assume for a moment we can do that (it might require an upstream change, though). In that case, for me the biggest difference is when you go for example to the Python section of the docs. _With_ this dropdown, the left sidebar should now only show links relevant to Python, not all other languages? 
   
   > I have played around with the logo a bit because it is not clearly visible if located on the top navbar. It might make sense to keep it on the left side bar as is (see picture below).
   
   Yes, it's indeed not very big .. Putting the logo on the sidebar gives a bit strange effect for the top navbar though, I find (with the navigation items being above the logo). 
   Another option might be to make the navbar or navbar img a bit larger, which I think is something that numpy did (https://github.com/numpy/numpy/blob/0febb4c40e98dc6fe35c7bcd672d0a6c438cd5c8/doc/source/_static/numpy.css#L3-L8)


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] rok commented on pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "rok (via GitHub)" <gi...@apache.org>.
rok commented on PR #36591:
URL: https://github.com/apache/arrow/pull/36591#issuecomment-1638899746

   Thanks for doing this @AlenkaF! Preview looks pretty nice.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] github-actions[bot] commented on pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #36591:
URL: https://github.com/apache/arrow/pull/36591#issuecomment-1709545837

   Revision: bb72e64b45fe041b223beb3c84c7a7dd42c38955
   
   Submitted crossbow builds: [ursacomputing/crossbow @ actions-dd781f709a](https://github.com/ursacomputing/crossbow/branches/all?query=actions-dd781f709a)
   
   |Task|Status|
   |----|------|
   |preview-docs|[![Github Actions](https://github.com/ursacomputing/crossbow/workflows/Crossbow/badge.svg?branch=actions-dd781f709a-github-preview-docs)](https://github.com/ursacomputing/crossbow/actions/runs/6106188058/job/16570851393)|


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] AlenkaF commented on pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "AlenkaF (via GitHub)" <gi...@apache.org>.
AlenkaF commented on PR #36591:
URL: https://github.com/apache/arrow/pull/36591#issuecomment-1717263113

   > I do think that it would be more efficient to design UX/UI in a prototype tool instead of prototyping in this PR. An example tool would be Figma.
   
   That is a good idea! I hope you do not mind suggesting we leave this for another time? There was already quite some time dedicated to general design review in July/August and suggestions have been included. I would rather focus on the technical part now to get this PR into 14.0.0 release.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] AlenkaF commented on a diff in pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "AlenkaF (via GitHub)" <gi...@apache.org>.
AlenkaF commented on code in PR #36591:
URL: https://github.com/apache/arrow/pull/36591#discussion_r1324058852


##########
docs/source/conf.py:
##########
@@ -354,10 +375,9 @@
 
 # Custom sidebar templates, maps document names to template names.
 #
-html_sidebars = {
+# html_sidebars = {
 #    '**': ['sidebar-logo.html', 'sidebar-search-bs.html', 'sidebar-nav-bs.html'],
-    '**': ['docs-sidebar.html'],
-}
+# }

Review Comment:
   See above. Happy to remove if I misunderstood it.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] AlenkaF commented on pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "AlenkaF (via GitHub)" <gi...@apache.org>.
AlenkaF commented on PR #36591:
URL: https://github.com/apache/arrow/pull/36591#issuecomment-1722843278

   @github-actions crossbow submit preview-docs


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] github-actions[bot] commented on pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #36591:
URL: https://github.com/apache/arrow/pull/36591#issuecomment-1722845835

   Revision: 5d66af2ce8eb140ef8cbeed9efde2484bf558571
   
   Submitted crossbow builds: [ursacomputing/crossbow @ actions-4cbfb04d40](https://github.com/ursacomputing/crossbow/branches/all?query=actions-4cbfb04d40)
   
   |Task|Status|
   |----|------|
   |preview-docs|[![Github Actions](https://github.com/ursacomputing/crossbow/workflows/Crossbow/badge.svg?branch=actions-4cbfb04d40-github-preview-docs)](https://github.com/ursacomputing/crossbow/actions/runs/6219183725/job/16876798083)|


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] AlenkaF commented on pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "AlenkaF (via GitHub)" <gi...@apache.org>.
AlenkaF commented on PR #36591:
URL: https://github.com/apache/arrow/pull/36591#issuecomment-1647193887

   > Looks neat! It is a bit jarring that the R docs are the only ones that are not a separate site but use a different theme... maybe we can convert those to using sphinx too? (a quick search revealed https://docs.ropensci.org/r2readthedocs/ as a potential solution for that?)
   
   Thanks for looking at it Jacob!
   From the technical perspective I think it is a good idea to research. But I am not sure how would that affect the R team. @thisisnic @paleolimbot what is your opinion on having the R docs converted to use Sphinx?


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] AlenkaF commented on pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "AlenkaF (via GitHub)" <gi...@apache.org>.
AlenkaF commented on PR #36591:
URL: https://github.com/apache/arrow/pull/36591#issuecomment-1648344963

   > We could consider changing the theme to match more aesthetically, if someone wants to submit a PR for that though? I'm not sure it's necessary though - is it a problem if it doesn't match?
   
   I do not think it is a problem. If there would be strong vote to update it, I am happy to help. Otherwise the R docs are not the only part of the project with different docs theme.
   
   So, after reading the argumants Nic posted, I do not see a reason to complicate things and would leave the R docs as they are.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] AlenkaF commented on pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "AlenkaF (via GitHub)" <gi...@apache.org>.
AlenkaF commented on PR #36591:
URL: https://github.com/apache/arrow/pull/36591#issuecomment-1638116947

   @github-actions crossbow submit preview-docs


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] AlenkaF commented on pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "AlenkaF (via GitHub)" <gi...@apache.org>.
AlenkaF commented on PR #36591:
URL: https://github.com/apache/arrow/pull/36591#issuecomment-1630709248

   > Yes, if we do this, we should certainly ensure we can call it something more informative than "More". But assume for a moment we can do that (it might require an upstream change, though)
   
   Opened an issue for it: https://github.com/pydata/pydata-sphinx-theme/issues/1386


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] AlenkaF commented on pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "AlenkaF (via GitHub)" <gi...@apache.org>.
AlenkaF commented on PR #36591:
URL: https://github.com/apache/arrow/pull/36591#issuecomment-1630611773

   > With this dropdown, the left sidebar should now only show links relevant to Python, not all other languages?
   
   Oh, that is true! Will use the dropdown then and see what can be done with the title of the button.
   
   > Another option might be to make the navbar or navbar img a bit larger ...
   
   Yes, I think that would be a good option also.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow] AlenkaF commented on pull request #36591: GH-36590: [Docs] Support Pydata Sphinx Theme 0.13

Posted by "AlenkaF (via GitHub)" <gi...@apache.org>.
AlenkaF commented on PR #36591:
URL: https://github.com/apache/arrow/pull/36591#issuecomment-1630726691

   @github-actions crossbow submit preview-docs


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org