You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@systemds.apache.org by GitBox <gi...@apache.org> on 2021/06/30 10:59:42 UTC
[GitHub] [systemds] Baunsgaard commented on a change in pull request #1331: [DOCS] updateAPI.sh usage requirements and instructions
Baunsgaard commented on a change in pull request #1331:
URL: https://github.com/apache/systemds/pull/1331#discussion_r661348730
##########
File path: docs/README.md
##########
@@ -66,6 +66,37 @@ The Documentation is separated into different parts by sub folders.
To update the API documentation run the `updateAPI.sh` file.
Note that you have to install both the Java and Python -doc dependencies.
+#### Linux
+
+1. Install [Sphinx](https://pypi.org/project/Sphinx/) and [sphinx_rtd_theme](https://pypi.org/project/sphinx-rtd-theme/).
+
+```bash
+pip install Sphinx
+pip install sphinx-rtd-theme
Review comment:
we can combine all these pip installs into one line. put it on the step 3 in install python dependencies, above.
##########
File path: docs/README.md
##########
@@ -66,6 +66,37 @@ The Documentation is separated into different parts by sub folders.
To update the API documentation run the `updateAPI.sh` file.
Note that you have to install both the Java and Python -doc dependencies.
+#### Linux
Review comment:
Ubuntu is Linux in this context,
##########
File path: docs/README.md
##########
@@ -66,6 +66,37 @@ The Documentation is separated into different parts by sub folders.
To update the API documentation run the `updateAPI.sh` file.
Note that you have to install both the Java and Python -doc dependencies.
+#### Linux
+
+1. Install [Sphinx](https://pypi.org/project/Sphinx/) and [sphinx_rtd_theme](https://pypi.org/project/sphinx-rtd-theme/).
+
+```bash
+pip install Sphinx
+pip install sphinx-rtd-theme
+```
+
+2. After that, install Python dependencies.
+
+```bash
+pip install numpy pandas py4j
Review comment:
combine with the pip install
##########
File path: docs/README.md
##########
@@ -66,6 +66,37 @@ The Documentation is separated into different parts by sub folders.
To update the API documentation run the `updateAPI.sh` file.
Note that you have to install both the Java and Python -doc dependencies.
+#### Linux
+
+1. Install [Sphinx](https://pypi.org/project/Sphinx/) and [sphinx_rtd_theme](https://pypi.org/project/sphinx-rtd-theme/).
+
+```bash
+pip install Sphinx
+pip install sphinx-rtd-theme
+```
+
+2. After that, install Python dependencies.
+
+```bash
+pip install numpy pandas py4j
+```
+
+and install any other missing packages.
+
+3. Make sure Maven and Java 8 are installed.
Review comment:
sure add this as step 4. in the Ubuntu install,
add a new step 5 mark it as optional, and write the call to updateAPI.sh
then move the old step 4 to a step 6
##########
File path: docs/README.md
##########
@@ -66,6 +66,37 @@ The Documentation is separated into different parts by sub folders.
To update the API documentation run the `updateAPI.sh` file.
Note that you have to install both the Java and Python -doc dependencies.
+#### Linux
+
+1. Install [Sphinx](https://pypi.org/project/Sphinx/) and [sphinx_rtd_theme](https://pypi.org/project/sphinx-rtd-theme/).
+
+```bash
+pip install Sphinx
+pip install sphinx-rtd-theme
+```
+
+2. After that, install Python dependencies.
+
+```bash
+pip install numpy pandas py4j
+```
+
+and install any other missing packages.
+
+3. Make sure Maven and Java 8 are installed.
+
+```bash
+mvn --version
+```
+
+Note: After Java 8, `jdk.tools:jdk.tools:jar` are [removed from jdk](https://openjdk.java.net/jeps/220#:~:text=rt.jar%20and%20tools.jar)
+
+Now, update the API docs with
+
+```bash
+./updateAPI.sh
+```
+
## Mac Install
Review comment:
we can probably also update the mac guide to install all pip packages needed, just simply change that line only to install all the packages.
--
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: dev-unsubscribe@systemds.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org