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/06/26 09:07:54 UTC

[GitHub] [arrow] AlenkaF opened a new pull request, #36296: GH-35403: [Docs] Support sphinx 6 for building the docs

AlenkaF opened a new pull request, #36296:
URL: https://github.com/apache/arrow/pull/36296

   ### What changes are included in this PR?
   
   Enable the docs to be built with sphinx 6.x.
   - Update the pin in the `requirements.txt`
   - Add `sphinxcontrib.jquery` to include jQuery which is used in the dropdown.
   
   ### Are these changes tested?
   
   The Sphinx version update is tested locally (and on the CI).
   The dropdown for documentation versions is not tested yet.
   
   ### 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 #36296: GH-35403: [Docs] Support sphinx 6 for building the docs

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

   The docs/requirements.txt file has a comment that it should be kept in sync with conda_env_sphinx.txt, so in both places 


-- 
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 #36296: GH-35403: [Docs] Support sphinx 6 for building the docs

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

   @AlenkaF you can maybe open a PR on the conda feedstock to update the upper pin (eg to <7), since it seems breathe itself is now testing with sphinx 6 (https://github.com/breathe-doc/breathe/commit/ef4e245804759d44ae54fc832b4d5155837f0720), so that should be expected to work


-- 
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 a diff in pull request #36296: GH-35403: [Docs] Support sphinx 6 for building the docs

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


##########
docs/source/developers/java/building.rst:
##########
@@ -195,7 +195,7 @@ CMake
 
 - To build all JNI libraries (MacOS / Linux) except the JNI C Data Interface library:
 
-  .. code-block::
+  .. code-block:: text

Review Comment:
   ```suggestion
     .. code-block:: console
   ```



##########
docs/Makefile:
##########
@@ -150,6 +150,8 @@ cpp-live:
 
 .PHONY: python
 python:
+	# Remove the following line when sphinx issue (https://github.com/sphinx-doc/sphinx/issues/10943) is closed
+	python -m pip install ../python --quiet --no-dependencies

Review Comment:
   Can we move this to caller of `make python`?
   If we put this here, this command is always executed for `make python`.
   (I think that we only need to execute this once.)



-- 
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 #36296: GH-35403: [Docs] Support sphinx 6 for building the docs

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


##########
docs/source/developers/java/building.rst:
##########
@@ -195,7 +195,7 @@ CMake
 
 - To build all JNI libraries (MacOS / Linux) except the JNI C Data Interface library:
 
-  .. code-block::
+  .. code-block:: text

Review Comment:
   Maybe you need to add `#` comment indicator to the lines with free text?



-- 
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 #36296: GH-35403: [Docs] Support sphinx 6 for building the docs

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


##########
docs/Makefile:
##########
@@ -150,6 +150,8 @@ cpp-live:
 
 .PHONY: python
 python:
+	# Remove the following line when sphinx issue (https://github.com/sphinx-doc/sphinx/issues/10943) is closed
+	python -m pip install ../python --quiet --no-dependencies

Review Comment:
   Agree. Will only add a note for the MacOS users in the docs 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] jorisvandenbossche merged pull request #36296: GH-35403: [Docs] Support sphinx 6 for building the docs

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


-- 
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 #36296: GH-35403: [Docs] Support sphinx 6 for building the docs

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

   I am not sure why is the installed Sphinx version on the CI still 5.3.0 (`ci/conda_env_sphinx.txt` is updated)
   https://github.com/apache/arrow/actions/runs/5387119645/jobs/9778004280?pr=36296#step:6:1351
   
   So this change is currently not tested on the CI.


-- 
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 #36296: GH-35403: [Docs] Support sphinx 6 for building the docs

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

   Hmm, that should already have been removed in breathe a long time ago: https://github.com/breathe-doc/breathe/pull/512 
   What version of breathe do we have installed?


-- 
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 #36296: GH-35403: [Docs] Support sphinx 6 for building the docs

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


##########
docs/source/developers/java/building.rst:
##########
@@ -195,7 +195,7 @@ CMake
 
 - To build all JNI libraries (MacOS / Linux) except the JNI C Data Interface library:
 
-  .. code-block::
+  .. code-block:: text

Review Comment:
   `#` comment indicator to the lines with free text solves the issue 👍 



-- 
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 #36296: GH-35403: [Docs] Support sphinx 6 for building the docs

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


##########
docs/source/developers/documentation.rst:
##########
@@ -87,6 +87,14 @@ These two steps are mandatory and must be executed in order.
    not sufficiently comprehensive. Portions of the Python API documentation
    will also not build without CUDA support having been built.
 
+.. note::
+
+   If you are working on the Python documentation and are building the documentation
+   with ``pyarrow`` build from source on macOS Monterey, Python section of the
+   documentation might not be included in the ``_build/html``. In this case run
+   ``python -m pip install ../python --quiet --no-dependencies python`` before
+   running the ``make html`` command.

Review Comment:
   > This is essentially installing the package in non-editable mode, right? Maybe mention that explicitly to clarify what the command is exactly doing
   
   Yes, correct. Will do.
   
   > Also, what does the --no-dependencies python do?
   
   Last `python` is a typo. The `--no-dependencies` is something I saw others use but didn't bother to double check as it was working locally, sorry about that. Running `pip install -h` lists
   
   ```--no-deps                   Don't install package dependencies.```
   
   The dependencies will already be installed in our case so this doesn't really have an effect I suppose. Will remove.



-- 
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 a diff in pull request #36296: GH-35403: [Docs] Support sphinx 6 for building the docs

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


##########
docs/Makefile:
##########
@@ -150,6 +150,8 @@ cpp-live:
 
 .PHONY: python
 python:
+	# Remove the following line when sphinx issue (https://github.com/sphinx-doc/sphinx/issues/10943) is closed
+	python -m pip install ../python --quiet --no-dependencies

Review Comment:
   I think that the approach is better.
   But I'm not a `make python` user. If other `make python` users like the current approach (`with `pip install` command) , I don't object the current approach.



-- 
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 #36296: GH-35403: [Docs] Support sphinx 6 for building the docs

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


##########
docs/Makefile:
##########
@@ -150,6 +150,8 @@ cpp-live:
 
 .PHONY: python
 python:
+	# Remove the following line when sphinx issue (https://github.com/sphinx-doc/sphinx/issues/10943) is closed
+	python -m pip install ../python --quiet --no-dependencies

Review Comment:
   I also prefer not to have this pip install here. For people that don't need it (like me, not on Mac), that would be quite annoying. 



-- 
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 a diff in pull request #36296: GH-35403: [Docs] Support sphinx 6 for building the docs

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


##########
docs/source/developers/java/building.rst:
##########
@@ -195,7 +195,7 @@ CMake
 
 - To build all JNI libraries (MacOS / Linux) except the JNI C Data Interface library:
 
-  .. code-block::
+  .. code-block:: text

Review Comment:
   Oh...
   
   Does the following change solve it?
   
   ```diff
   diff --git a/docs/source/developers/java/building.rst b/docs/source/developers/java/building.rst
   index c400b95f2..e8a499d1c 100644
   --- a/docs/source/developers/java/building.rst
   +++ b/docs/source/developers/java/building.rst
   @@ -203,7 +203,7 @@ CMake
          $ brew uninstall aws-sdk-cpp
          (We can't use aws-sdk-cpp installed by Homebrew because it has
          an issue: https://github.com/aws/aws-sdk-cpp/issues/1809 )
   -      $ export JAVA_HOME=<absolute path to your java home>
   +      $ export JAVA_HOME=${ABSOLUTE_PATH_TO_YOUR_JAVA_HOME}
          $ mkdir -p java-dist cpp-jni
          $ cmake \
              -S cpp \
   @@ -221,7 +221,7 @@ CMake
              -DARROW_S3=ON \
              -DARROW_USE_CCACHE=ON \
              -DCMAKE_BUILD_TYPE=Release \
   -          -DCMAKE_INSTALL_LIBDIR=lib/<your system's architecture> \
   +          -DCMAKE_INSTALL_LIBDIR=lib/${YOUR_SYSTEM_ARCHITECTURE} \
              -DCMAKE_INSTALL_PREFIX=java-dist \
              -DCMAKE_UNITY_BUILD=ON
          $ cmake --build cpp-jni --target install --config Release
   @@ -232,11 +232,11 @@ CMake
              -DARROW_JAVA_JNI_ENABLE_DEFAULT=ON \
              -DBUILD_TESTING=OFF \
              -DCMAKE_BUILD_TYPE=Release \
   -          -DCMAKE_INSTALL_LIBDIR=lib/<your system's architecture> \
   +          -DCMAKE_INSTALL_LIBDIR=lib/${YOUR_SYSTEM_ARCHITECTURE} \
              -DCMAKE_INSTALL_PREFIX=java-dist \
              -DCMAKE_PREFIX_PATH=$PWD/java-dist
          $ cmake --build java-jni --target install --config Release
   -      $ ls -latr java-dist/lib/<your system's architecture>/*_{jni,java}.*
   +      $ ls -latr java-dist/lib/${YOUR_SYSTEM_ARCHITECTURE}/*_{jni,java}.*
          |__ libarrow_dataset_jni.dylib
          |__ libarrow_orc_jni.dylib
          |__ libgandiva_jni.dylib
   ```



-- 
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 #36296: GH-35403: [Docs] Support sphinx 6 for building the docs

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


##########
docs/source/developers/documentation.rst:
##########
@@ -87,6 +87,14 @@ These two steps are mandatory and must be executed in order.
    not sufficiently comprehensive. Portions of the Python API documentation
    will also not build without CUDA support having been built.
 
+.. note::
+
+   If you are working on the Python documentation and are building the documentation
+   with ``pyarrow`` build from source on macOS Monterey, Python section of the
+   documentation might not be included in the ``_build/html``. In this case run
+   ``python -m pip install ../python --quiet --no-dependencies python`` before
+   running the ``make html`` command.

Review Comment:
   This is essentially installing the package in non-editable mode, right? Maybe mention that explicitly to clarify what the command is exactly doing
   
   Also, what does the `--no-dependencies python` do?



-- 
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 #36296: GH-35403: [Docs] Support sphinx 6 for building the docs

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

   Here it is: https://github.com/conda-forge/breathe-feedstock/pull/59


-- 
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 #36296: GH-35403: [Docs] Support sphinx 6 for building the docs

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

   There is no issue with the docs build on the CI after the PR on conda-forge/breathe-feedstock got merged 👍 The version of Sphinx used on the CI is `6.2.0` and the version of Breathe is `4.35.0`.
   
   Note: in [the last commit](https://github.com/apache/arrow/pull/36296/commits/c41cbced65f0c45d46d05b17e6acc1c6875b4af2) I have added a make option for MacOS related issues with editable libs. I am not sure if the approach is correct though.


-- 
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 #36296: GH-35403: [Docs] Support sphinx 6 for building the docs

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


##########
docs/source/developers/java/building.rst:
##########
@@ -195,7 +195,7 @@ CMake
 
 - To build all JNI libraries (MacOS / Linux) except the JNI C Data Interface library:
 
-  .. code-block::
+  .. code-block:: text

Review Comment:
   Unfortunately the `console` code block also triggers this warning I tried to fix:
   
   ```
   /Users/alenkafrim/repos/arrow-new-docs/docs/source/developers/java/building.rst:198: WARNING: Could not lex literal_block "$ cd arrow\n$ brew bundle --file=cpp/Brewfile\nHomebrew Bundle complete! 25 Brewfile dependencies now installed.\n$ brew uninstall aws-sdk-cpp\n(We can't use aws-sdk-cpp installed by Homebrew because it has\nan issue: https://github.com/aws/aws-sdk-cpp/issues/1809 )\n$ export JAVA_HOME=<absolute path to your java home>\n$ mkdir -p java-dist cpp-jni\n$ cmake \\\n    -S cpp \\\n    -B cpp-jni \\\n    -DARROW_BUILD_SHARED=OFF \\\n    -DARROW_CSV=ON \\\n    -DARROW_DATASET=ON \\\n    -DARROW_DEPENDENCY_SOURCE=BUNDLED \\\n    -DARROW_DEPENDENCY_USE_SHARED=OFF \\\n    -DARROW_FILESYSTEM=ON \\\n    -DARROW_GANDIVA=ON \\\n    -DARROW_GANDIVA_STATIC_LIBSTDCPP=ON \\\n    -DARROW_ORC=ON \\\n    -DARROW_PARQUET=ON \\\n    -DARROW_S3=ON \\\n    -DARROW_USE_CCACHE=ON \\\n    -DCMAKE_BUILD_TYPE=Release \\\n    -DCMAKE_INSTALL_LIBDIR=lib/<your system's architecture> \\\n    -
 DCMAKE_INSTALL_PREFIX=java-dist \\\n    -DCMAKE_UNITY_BUILD=ON\n$ cmake --build cpp-jni --target install --config Release\n$ cmake \\\n    -S java \\\n    -B java-jni \\\n    -DARROW_JAVA_JNI_ENABLE_C=OFF \\\n    -DARROW_JAVA_JNI_ENABLE_DEFAULT=ON \\\n    -DBUILD_TESTING=OFF \\\n    -DCMAKE_BUILD_TYPE=Release \\\n    -DCMAKE_INSTALL_LIBDIR=lib/<your system's architecture> \\\n    -DCMAKE_INSTALL_PREFIX=java-dist \\\n    -DCMAKE_PREFIX_PATH=$PWD/java-dist\n$ cmake --build java-jni --target install --config Release\n$ ls -latr java-dist/lib/<your system's architecture>/*_{jni,java}.*\n|__ libarrow_dataset_jni.dylib\n|__ libarrow_orc_jni.dylib\n|__ libgandiva_jni.dylib" as "console". Highlighting skipped.
   ```



-- 
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 #36296: GH-35403: [Docs] Support sphinx 6 for building the docs

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


##########
docs/source/developers/documentation.rst:
##########
@@ -92,6 +92,21 @@ format in ``arrow/docs/_build/html``.  In particular, you can point your browser
 at ``arrow/docs/_build/html/index.html`` to read the docs and review any changes
 you made.
 
+.. note::
+
+   If you are working on the Python documentation and are building the documentation
+   with ``pyarrow`` build from source on macOS Monterey, Python section of the
+   documentation might not be included in the ``_build/html``. In this case try
+   installing ``pyarrow`` in editable version first before running the ``make html``
+   command.

Review Comment:
   ```suggestion
      with ``pyarrow`` build from source on macOS Monterey, the Python section of the
      documentation might not be included in the ``_build/html``. In this case, try
      installing ``pyarrow`` in non-editable mode first before running the ``make html``
      command.
   ```



-- 
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 #36296: GH-35403: [Docs] Support sphinx 6 for building the docs

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

   Sure will do! 👍 


-- 
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 #36296: GH-35403: [Docs] Support sphinx 6 for building the docs

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

   @github-actions crossbow submit -g integration


-- 
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 #36296: GH-35403: [Docs] Support sphinx 6 for building the docs

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


##########
docs/source/developers/java/building.rst:
##########
@@ -195,7 +195,7 @@ CMake
 
 - To build all JNI libraries (MacOS / Linux) except the JNI C Data Interface library:
 
-  .. code-block::
+  .. code-block:: text

Review Comment:
   Will try 👍 



-- 
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 #36296: GH-35403: [Docs] Support sphinx 6 for building the docs

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

   Not sure why it doesn't automatically use sphinx 6, but we could also just force `sphinx=6` in the conda env file, I think that would be fine (from testing locally there doesn't seem to be a conflict when doing 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 pull request #36296: GH-35403: [Docs] Support sphinx 6 for building the docs

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

   > Not sure why it doesn't automatically use sphinx 6, but we could also just force `sphinx=6` in the conda env file, I think that would be fine (from testing locally there doesn't seem to be a conflict when doing that).
   
   Just on the CI or in general requirements 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 #36296: GH-35403: [Docs] Support sphinx 6 for building the docs

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

   Oh forgot about that, sry. Will change 👍 


-- 
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 #36296: GH-35403: [Docs] Support sphinx 6 for building the docs

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

   The issue on the failing build is 
   
   ```
   
   Running Sphinx v6.2.0
   
   Exception occurred:
     File "/opt/conda/envs/arrow/lib/python3.9/site-packages/breathe/renderer/sphinxrenderer.py", line 104, in DomainDirectiveFactory
       'function': (python.PyModulelevel, 'function'),
   AttributeError: module 'sphinx.domains.python' has no attribute 'PyModulelevel'
   ```
   
   but Sphinx deprecated `sphinx.domains.python.PyModulelevel` in 4.0, so this should have come up before already?
   https://www.sphinx-doc.org/en/master/extdev/deprecated.html


-- 
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 #36296: GH-35403: [Docs] Support sphinx 6 for building the docs

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

   Conbench analyzed the 6 benchmark runs on commit `82bf1e28`.
   
   There were no benchmark performance regressions. 🎉
   
   The [full Conbench report](https://github.com/apache/arrow/runs/14960663309) 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] kou commented on a diff in pull request #36296: GH-35403: [Docs] Support sphinx 6 for building the docs

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


##########
docs/Makefile:
##########
@@ -150,6 +150,8 @@ cpp-live:
 
 .PHONY: python
 python:
+	# Remove the following line when sphinx issue (https://github.com/sphinx-doc/sphinx/issues/10943) is closed
+	python -m pip install ../python --quiet --no-dependencies

Review Comment:
   I think that the approach is better.
   But I'm not a `make python` user. If other `make python` users like the current approach (with `pip install` command) , I don't object the current approach.



-- 
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 #36296: GH-35403: [Docs] Support sphinx 6 for building the docs

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

   OK, so we have an old version of breathe, this might be because more recent versions on conda-forge have an upper pin to sphinx: https://github.com/conda-forge/breathe-feedstock/blob/e22b71d442aa41ed3e7614eddb4d129c893bacab/recipe/meta.yaml#L28


-- 
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 #36296: GH-35403: [Docs] Support sphinx 6 for building the docs

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


##########
docs/Makefile:
##########
@@ -150,6 +150,8 @@ cpp-live:
 
 .PHONY: python
 python:
+	# Remove the following line when sphinx issue (https://github.com/sphinx-doc/sphinx/issues/10943) is closed
+	python -m pip install ../python --quiet --no-dependencies

Review Comment:
   Correct, it only needs to be executed once.
   
   We could also keep Makefile as is (without `pip install` command) and add the info to the docs for the user with MacOS issues to run `python -m pip install ../python --quiet --no-dependencies` before calling any of the make commands? That would keep the workflow optimised without an extra install for other users and would enable the correct build for all make targets for MacOS users?



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