nchammas commented on a change in pull request #27534: [SPARK-30731][DOCS] Refine workflow for building docs URL: https://github.com/apache/spark/pull/27534#discussion_r377433240
########## 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: We should pin dependencies for the usual reason: It guarantees a stable environment that gives reproducible results. New releases may have breaking behavior, so you don't always want to install the latest version. And different users building the docs may have outdated versions installed, which will yield them a broken build. (e.g. If you ran `pip install sphinx` when the latest release was 1.1.0, then pip will not update your version of sphinx as new releases are made unless you explicitly request it via `pip install --upgrade`.) These categories of build problem are addressed by pinning versions. ---------------------------------------------------------------- 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]
