You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@arrow.apache.org by GitBox <gi...@apache.org> on 2021/12/07 08:02:04 UTC

[GitHub] [arrow] AlenkaF opened a new pull request #11878: ARROW-8340: [Documentation] Sphinx documentation does not build with just-released Sphinx 3.0.0

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


   Remove the pin for `Sphinx` in `requirements.txt`. The documentation builds successfully with `Sphinx` version 4.3.1.


-- 
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] kszucs closed pull request #11878: ARROW-8340: [Documentation] Remove the old Sphinx pin

Posted by GitBox <gi...@apache.org>.
kszucs closed pull request #11878:
URL: https://github.com/apache/arrow/pull/11878


   


-- 
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] kszucs commented on a change in pull request #11878: ARROW-8340: [Documentation] Sphinx documentation does not build with just-released Sphinx 3.0.0

Posted by GitBox <gi...@apache.org>.
kszucs commented on a change in pull request #11878:
URL: https://github.com/apache/arrow/pull/11878#discussion_r763996855



##########
File path: docs/requirements.txt
##########
@@ -1,6 +1,7 @@
 breathe
 ipython
 numpydoc
-sphinx==2.4.4
+meson

Review comment:
       `meson` is required to build the C Glib bindings but it was consolidated into a single `pip install` command in the dockerfile above. Please remove `meson` from here and install meson in addition to the requirements.txt




-- 
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] kszucs edited a comment on pull request #11878: ARROW-8340: [Documentation] Sphinx documentation does not build with just-released Sphinx 3.0.0

Posted by GitBox <gi...@apache.org>.
kszucs edited a comment on pull request #11878:
URL: https://github.com/apache/arrow/pull/11878#issuecomment-987788801


   @AlenkaF could you please reference this requirements file from https://github.com/apache/arrow/blob/master/ci/docker/linux-apt-docs.dockerfile#L77 ?
   
   Need to add to `.dockerignore` before using `COPY` in the dockerfile.


-- 
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] kszucs commented on a change in pull request #11878: ARROW-8340: [Documentation] Remove the old Sphinx pin

Posted by GitBox <gi...@apache.org>.
kszucs commented on a change in pull request #11878:
URL: https://github.com/apache/arrow/pull/11878#discussion_r764764949



##########
File path: ci/docker/linux-apt-docs.dockerfile
##########
@@ -74,13 +74,7 @@ RUN wget -q -O - https://deb.nodesource.com/setup_${node}.x | bash - && \
     rm -rf /var/lib/apt/lists/* && \
     npm install -g yarn
 

Review comment:
       Need to add the copy statement so the image layer has the requirements file at build time:
   
   ```
   COPY docs/requirements.txt /arrow/docs/
   RUN pip install -r docs/requirements.txt meson
   ```




-- 
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 change in pull request #11878: ARROW-8340: [Documentation] Remove the old Sphinx pin

Posted by GitBox <gi...@apache.org>.
AlenkaF commented on a change in pull request #11878:
URL: https://github.com/apache/arrow/pull/11878#discussion_r764801314



##########
File path: ci/docker/linux-apt-docs.dockerfile
##########
@@ -74,13 +74,7 @@ RUN wget -q -O - https://deb.nodesource.com/setup_${node}.x | bash - && \
     rm -rf /var/lib/apt/lists/* && \
     npm install -g yarn
 

Review comment:
       Will do!
   Thanks for additional instructions, I was lost =)




-- 
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 change in pull request #11878: ARROW-8340: [Documentation] Sphinx documentation does not build with just-released Sphinx 3.0.0

Posted by GitBox <gi...@apache.org>.
jorisvandenbossche commented on a change in pull request #11878:
URL: https://github.com/apache/arrow/pull/11878#discussion_r763967705



##########
File path: docs/requirements.txt
##########
@@ -1,6 +1,7 @@
 breathe
 ipython
 numpydoc
-sphinx==2.4.4
+meson

Review comment:
       Why is meson needed here?

##########
File path: docs/requirements.txt
##########
@@ -1,6 +1,7 @@
 breathe
 ipython
 numpydoc
-sphinx==2.4.4
+meson
 pydata-sphinx-theme
 sphinx-tabs
+sphinx>=4.2

Review comment:
       Can you maybe add a comment here in this file somewhere pointing to `conda_env_sphinx.txt` and with the message that those two files need to be kept in sync (so if changing the one, also need to update the other)?




-- 
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] kszucs commented on a change in pull request #11878: ARROW-8340: [Documentation] Remove the old Sphinx pin

Posted by GitBox <gi...@apache.org>.
kszucs commented on a change in pull request #11878:
URL: https://github.com/apache/arrow/pull/11878#discussion_r764767629



##########
File path: ci/docker/linux-apt-docs.dockerfile
##########
@@ -74,13 +74,7 @@ RUN wget -q -O - https://deb.nodesource.com/setup_${node}.x | bash - && \
     rm -rf /var/lib/apt/lists/* && \
     npm install -g yarn
 

Review comment:
       Then run `archery docker run conda-python-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] kszucs commented on pull request #11878: ARROW-8340: [Documentation] Sphinx documentation does not build with just-released Sphinx 3.0.0

Posted by GitBox <gi...@apache.org>.
kszucs commented on pull request #11878:
URL: https://github.com/apache/arrow/pull/11878#issuecomment-987788801


   @AlenkaF could you please reference this requirements file from https://github.com/apache/arrow/blob/master/ci/docker/linux-apt-docs.dockerfile#L77 ?


-- 
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] kszucs commented on a change in pull request #11878: ARROW-8340: [Documentation] Remove the old Sphinx pin

Posted by GitBox <gi...@apache.org>.
kszucs commented on a change in pull request #11878:
URL: https://github.com/apache/arrow/pull/11878#discussion_r764767063



##########
File path: ci/docker/linux-apt-docs.dockerfile
##########
@@ -74,13 +74,7 @@ RUN wget -q -O - https://deb.nodesource.com/setup_${node}.x | bash - && \
     rm -rf /var/lib/apt/lists/* && \
     npm install -g yarn
 

Review comment:
       Also add `!docs/requirements*.txt` after this line https://github.com/apache/arrow/blob/master/.dockerignore#L30 in order to add the requirements file to the `docker context` where the COPY statement above gets it from.
   
   We need to ignore most of the file in the .dockerignore to prevent docker cache invalidation in certain circumstances.




-- 
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] kszucs commented on a change in pull request #11878: ARROW-8340: [Documentation] Remove the old Sphinx pin

Posted by GitBox <gi...@apache.org>.
kszucs commented on a change in pull request #11878:
URL: https://github.com/apache/arrow/pull/11878#discussion_r764767063



##########
File path: ci/docker/linux-apt-docs.dockerfile
##########
@@ -74,13 +74,7 @@ RUN wget -q -O - https://deb.nodesource.com/setup_${node}.x | bash - && \
     rm -rf /var/lib/apt/lists/* && \
     npm install -g yarn
 

Review comment:
       Also add `!docs/requirements*.txt` after this line https://github.com/apache/arrow/blob/master/.dockerignore#L30 in order to add the requirements file to the `docker context` where the COPY statement above gets it.
   
   We need to ignore most of the file in the .dockerignore to prevent docker cache invalidation in certain circumstances.




-- 
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] kszucs commented on a change in pull request #11878: ARROW-8340: [Documentation] Remove the old Sphinx pin

Posted by GitBox <gi...@apache.org>.
kszucs commented on a change in pull request #11878:
URL: https://github.com/apache/arrow/pull/11878#discussion_r764767629



##########
File path: ci/docker/linux-apt-docs.dockerfile
##########
@@ -74,13 +74,7 @@ RUN wget -q -O - https://deb.nodesource.com/setup_${node}.x | bash - && \
     rm -rf /var/lib/apt/lists/* && \
     npm install -g yarn
 

Review comment:
       Then run `archery docker run ubuntu-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 #11878: ARROW-8340: [Documentation] Sphinx documentation does not build with just-released Sphinx 3.0.0

Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on pull request #11878:
URL: https://github.com/apache/arrow/pull/11878#issuecomment-987665229






-- 
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 #11878: ARROW-8340: [Documentation] Sphinx documentation does not build with just-released Sphinx 3.0.0

Posted by GitBox <gi...@apache.org>.
AlenkaF commented on pull request #11878:
URL: https://github.com/apache/arrow/pull/11878#issuecomment-987826103


   > @AlenkaF could you please reference this requirements file from https://github.com/apache/arrow/blob/master/ci/docker/linux-apt-docs.dockerfile#L77 ?
   
   Happy to do it! (Change the requirements to be like in the dockerfile, if I understand correctly?)


-- 
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] kszucs commented on pull request #11878: ARROW-8340: [Documentation] Sphinx documentation does not build with just-released Sphinx 3.0.0

Posted by GitBox <gi...@apache.org>.
kszucs commented on pull request #11878:
URL: https://github.com/apache/arrow/pull/11878#issuecomment-987828826


   And then install the dependencies in the docker image using the docs/requirements.txt file.


-- 
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] kszucs commented on a change in pull request #11878: ARROW-8340: [Documentation] Sphinx documentation does not build with just-released Sphinx 3.0.0

Posted by GitBox <gi...@apache.org>.
kszucs commented on a change in pull request #11878:
URL: https://github.com/apache/arrow/pull/11878#discussion_r763995649



##########
File path: ci/docker/linux-apt-docs.dockerfile
##########
@@ -74,13 +74,7 @@ RUN wget -q -O - https://deb.nodesource.com/setup_${node}.x | bash - && \
     rm -rf /var/lib/apt/lists/* && \
     npm install -g yarn
 
-RUN pip install \
-        breathe \
-        ipython \
-        meson \
-        pydata-sphinx-theme \
-        sphinx-tabs \
-        sphinx>=4.2
+RUN pip install -r /arrow/docs/requirements.txt

Review comment:
       ```suggestion
   RUN pip install -r /arrow/docs/requirements.txt meson
   ```




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