nchammas commented on a change in pull request #27534: [SPARK-30879][DOCS] 
Refine workflow for building docs
URL: https://github.com/apache/spark/pull/27534#discussion_r386124976
 
 

 ##########
 File path: docs/README.md
 ##########
 @@ -58,7 +84,7 @@ Note: Other versions of roxygen2 might work in SparkR 
documentation generation b
 To generate API docs for any language, you'll need to install these libraries:
 
 ```sh
-$ sudo pip install sphinx mkdocs numpy
+pip install sphinx==2.3.1 mkdocs==1.0.4 numpy==1.18.1
 
 Review comment:
   I'm not following your concern about pinning versions. Is there some 
scenario or overhead from pinning versions that you are concerned about?
   
   It seems inevitable to me that contributors will waste time debugging issues 
that stem from them running different versions of these libraries. Instead of 
waiting for those issues to arise, it seems safe and simple enough to avoid 
them by pinning what we use. In fact, what prompted me to open this PR is an 
interaction I had with you on another PR where we were seeing different 
behavior when trying to build the docs. So I believe we've already seen at 
least one example of this problem. 😄 (I linked to that interaction from this 
PR's description.)
   
   Pinning our doc build dependencies is the core idea of this PR. If we don't 
want to do that, then I'm happy to close this PR and leave things 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.
 
For queries about this service, please contact Infrastructure at:
[email protected]


With regards,
Apache Git Services

---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to