[systemds] branch master updated: [DOCS] UpdateAPI.sh usage requirements and instructions (#1331)

[ja...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

janardhan pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/systemds.git


The following commit(s) were added to refs/heads/master by this push:
     new 3aaab14  [DOCS] UpdateAPI.sh usage requirements and instructions (#1331)
3aaab14 is described below

commit 3aaab1496576d811e1049bd004c6897acb04ff29
Author: Janardhan Pulivarthi <j1...@protonmail.com>
AuthorDate: Thu Jul 1 12:31:58 2021 +0530

    [DOCS] UpdateAPI.sh usage requirements and instructions (#1331)
    
    * python requirements, maven and java version requirements
    * add macos instructions for pip packages
---
 docs/README.md | 43 +++++++++++++++++++++++++++++++++----------
 1 file changed, 33 insertions(+), 10 deletions(-)

diff --git a/docs/README.md b/docs/README.md
index 3f14fa8..10d6d3d 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -53,22 +53,38 @@ The Documentation is separated into different parts by sub folders.
 
 3. Install python dependencies (Optionally).
 
-   - `pip install Pygments`
+   - Install [Sphinx](https://pypi.org/project/Sphinx/) and [sphinx_rtd_theme](https://pypi.org/project/sphinx-rtd-theme/).
 
-4. Launch the Documentation locally
+   ```bash
+   pip install Sphinx sphinx-rtd-theme
+   ```
+   - `pip install Pygments numpy pandas py4j`
+   
+   and install any other missing packages
 
-   - `jekyll serve -w`
-   - This is done from the root of the gh-pages branch of the system.
-   - The serving will per default be on localhost port 4000 [Link](http://localhost:4000)
+4. Make sure Maven and Java 8 are installed.
+
+   ```bash
+   mvn --version
+   ```
 
-### Update API
+   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)
 
-To update the API documentation run the `updateAPI.sh` file.
-Note that you have to install both the Java and Python -doc dependencies.
+5. Now, update the API docs (Optional)
 
+   ```bash
+   ./updateAPI.sh
+   ```
+
+6. Launch the Documentation locally
+
+   - `jekyll serve -w`
+   - The serving will per default be on localhost port 4000 [Link](http://localhost:4000)
+  
+  
 ## Mac Install
 
-Jekyll (and optionally Pygments) can be installed on the Mac OS in the following manner.
+1. Jekyll (and optionally Pygments) can be installed on the Mac OS in the following manner.
 
 ```bash
 brew install ruby
@@ -76,10 +92,17 @@ gem install jekyll
 gem install jekyll-redirect-from
 gem install bundler
 brew install python
-pip install Pygments
 gem install pygments.rb
 ```
 
+2. Python depedencies
+
+```bash
+pip install Sphinx sphinx-rtd-theme Pygments numpy pandas py4j
+```
+
+and install any missing Python packages.
+
 To generate SystemDS documentation in HTML, navigate to the ```docs``` folder, the root directory of the
 documentation. From there, you can have Jekyll convert the markdown files to HTML. If you run in server mode,
 Jekyll will serve up the generated documentation by default at <http://127.0.0.1:4000>. Modifications