j143 opened a new pull request, #1997:
URL: https://github.com/apache/systemds/pull/1997
.
---
steps to generate documentation:
```
@j143 ➜ .../src/main/python/docs (update-docs) $ python -m pip install -r
requires-docs.txt
Collecting sphinx (from -r requires-docs.txt (line 22))
Downloading sphinx-7.2.6-py3-none-any.whl.metadata (5.9 kB)
Collecting sphinx_rtd_theme (from -r requires-docs.txt (line 23))
Downloading sphinx_rtd_theme-2.0.0-py2.py3-none-any.whl.metadata (4.4 kB)
Requirement already satisfied: numpy in
/home/codespace/.local/lib/python3.10/site-packages (from -r requires-docs.txt
(line 24)) (1.26.3)
Collecting py4j (from -r requires-docs.txt (line 25))
Downloading py4j-0.10.9.7-py2.py3-none-any.whl (200 kB)
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 200.5/200.5 kB 1.4 MB/s eta
0:00:00
Requirement already satisfied: scipy in
/home/codespace/.local/lib/python3.10/site-packages (from -r requires-docs.txt
(line 26)) (1.11.4)
Requirement already satisfied: requests in
/home/codespace/.local/lib/python3.10/site-packages (from -r requires-docs.txt
(line 27)) (2.31.0)
Collecting sphinxcontrib-applehelp (from sphinx->-r requires-docs.txt (line
22))
Downloading sphinxcontrib_applehelp-1.0.8-py3-none-any.whl.metadata (2.3
kB)
Collecting sphinxcontrib-devhelp (from sphinx->-r requires-docs.txt (line
22))
Downloading sphinxcontrib_devhelp-1.0.6-py3-none-any.whl.metadata (2.3 kB)
Collecting sphinxcontrib-jsmath (from sphinx->-r requires-docs.txt (line 22))
Downloading sphinxcontrib_jsmath-1.0.1-py2.py3-none-any.whl (5.1 kB)
Collecting sphinxcontrib-htmlhelp>=2.0.0 (from sphinx->-r requires-docs.txt
(line 22))
Downloading sphinxcontrib_htmlhelp-2.0.5-py3-none-any.whl.metadata (2.3 kB)
Collecting sphinxcontrib-serializinghtml>=1.1.9 (from sphinx->-r
requires-docs.txt (line 22))
Downloading sphinxcontrib_serializinghtml-1.1.10-py3-none-any.whl.metadata
(2.4 kB)
Collecting sphinxcontrib-qthelp (from sphinx->-r requires-docs.txt (line 22))
Downloading sphinxcontrib_qthelp-1.0.7-py3-none-any.whl.metadata (2.2 kB)
Requirement already satisfied: Jinja2>=3.0 in
/home/codespace/.local/lib/python3.10/site-packages (from sphinx->-r
requires-docs.txt (line 22)) (3.1.2)
Requirement already satisfied: Pygments>=2.14 in
/home/codespace/.local/lib/python3.10/site-packages (from sphinx->-r
requires-docs.txt (line 22)) (2.17.2)
Collecting docutils<0.21,>=0.18.1 (from sphinx->-r requires-docs.txt (line
22))
Downloading docutils-0.20.1-py3-none-any.whl.metadata (2.8 kB)
Collecting snowballstemmer>=2.0 (from sphinx->-r requires-docs.txt (line 22))
Downloading snowballstemmer-2.2.0-py2.py3-none-any.whl (93 kB)
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 93.0/93.0 kB 2.2 MB/s eta
0:00:00
Requirement already satisfied: babel>=2.9 in
/home/codespace/.local/lib/python3.10/site-packages (from sphinx->-r
requires-docs.txt (line 22)) (2.14.0)
Collecting alabaster<0.8,>=0.7 (from sphinx->-r requires-docs.txt (line 22))
Downloading alabaster-0.7.16-py3-none-any.whl.metadata (2.9 kB)
Collecting imagesize>=1.3 (from sphinx->-r requires-docs.txt (line 22))
Downloading imagesize-1.4.1-py2.py3-none-any.whl (8.8 kB)
Requirement already satisfied: packaging>=21.0 in
/home/codespace/.local/lib/python3.10/site-packages (from sphinx->-r
requires-docs.txt (line 22)) (23.2)
Collecting sphinxcontrib-jquery<5,>=4 (from sphinx_rtd_theme->-r
requires-docs.txt (line 23))
Downloading sphinxcontrib_jquery-4.1-py2.py3-none-any.whl (121 kB)
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 121.1/121.1 kB 2.8 MB/s eta
0:00:00
Requirement already satisfied: charset-normalizer<4,>=2 in
/home/codespace/.local/lib/python3.10/site-packages (from requests->-r
requires-docs.txt (line 27)) (3.3.2)
Requirement already satisfied: idna<4,>=2.5 in
/home/codespace/.local/lib/python3.10/site-packages (from requests->-r
requires-docs.txt (line 27)) (3.6)
Requirement already satisfied: urllib3<3,>=1.21.1 in
/usr/local/python/3.10.13/lib/python3.10/site-packages (from requests->-r
requires-docs.txt (line 27)) (2.0.7)
Requirement already satisfied: certifi>=2017.4.17 in
/home/codespace/.local/lib/python3.10/site-packages (from requests->-r
requires-docs.txt (line 27)) (2023.11.17)
Requirement already satisfied: MarkupSafe>=2.0 in
/home/codespace/.local/lib/python3.10/site-packages (from
Jinja2>=3.0->sphinx->-r requires-docs.txt (line 22)) (2.1.3)
Downloading sphinx-7.2.6-py3-none-any.whl (3.2 MB)
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 3.2/3.2 MB 13.6 MB/s eta 0:00:00
Downloading sphinx_rtd_theme-2.0.0-py2.py3-none-any.whl (2.8 MB)
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 2.8/2.8 MB 33.1 MB/s eta 0:00:00
Downloading alabaster-0.7.16-py3-none-any.whl (13 kB)
Downloading docutils-0.20.1-py3-none-any.whl (572 kB)
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 572.7/572.7 kB 14.0 MB/s eta
0:00:00
Downloading sphinxcontrib_htmlhelp-2.0.5-py3-none-any.whl (99 kB)
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 99.2/99.2 kB 2.7 MB/s eta 0:00:00
Downloading sphinxcontrib_serializinghtml-1.1.10-py3-none-any.whl (92 kB)
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 92.7/92.7 kB 2.7 MB/s eta 0:00:00
Downloading sphinxcontrib_applehelp-1.0.8-py3-none-any.whl (120 kB)
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 120.0/120.0 kB 2.4 MB/s eta
0:00:00
Downloading sphinxcontrib_devhelp-1.0.6-py3-none-any.whl (83 kB)
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 83.5/83.5 kB 2.4 MB/s eta 0:00:00
Downloading sphinxcontrib_qthelp-1.0.7-py3-none-any.whl (89 kB)
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 89.4/89.4 kB 2.6 MB/s eta 0:00:00
Installing collected packages: snowballstemmer, py4j,
sphinxcontrib-serializinghtml, sphinxcontrib-qthelp, sphinxcontrib-jsmath,
sphinxcontrib-htmlhelp, sphinxcontrib-devhelp, sphinxcontrib-applehelp,
imagesize, docutils, alabaster, sphinx, sphinxcontrib-jquery, sphinx_rtd_theme
WARNING: The script docutils is installed in
'/usr/local/python/3.10.13/bin' which is not on PATH.
Consider adding this directory to PATH or, if you prefer to suppress this
warning, use --no-warn-script-location.
WARNING: The scripts sphinx-apidoc, sphinx-autogen, sphinx-build and
sphinx-quickstart are installed in '/usr/local/python/3.10.13/bin' which is not
on PATH.
Consider adding this directory to PATH or, if you prefer to suppress this
warning, use --no-warn-script-location.
Successfully installed alabaster-0.7.16 docutils-0.20.1 imagesize-1.4.1
py4j-0.10.9.7 snowballstemmer-2.2.0 sphinx-7.2.6 sphinx_rtd_theme-2.0.0
sphinxcontrib-applehelp-1.0.8 sphinxcontrib-devhelp-1.0.6
sphinxcontrib-htmlhelp-2.0.5 sphinxcontrib-jquery-4.1
sphinxcontrib-jsmath-1.0.1 sphinxcontrib-qthelp-1.0.7
sphinxcontrib-serializinghtml-1.1.10
[notice] A new release of pip is available: 23.3.2 -> 24.0
[notice] To update, run: python -m pip install --upgrade pip
```
```
@j143 ➜ /workspaces/systemds/docs (update-docs) $ ./updateAPI.sh
creating API docs
[INFO] Scanning for projects...
[INFO]
[INFO] --------------------< org.apache.systemds:systemds
>--------------------
[INFO] Building Apache SystemDS 3.2.0-SNAPSHOT
[INFO] from pom.xml
[INFO] --------------------------------[ jar
]---------------------------------
[INFO]
[INFO] --- clean:3.1.0:clean (default-clean) @ systemds ---
[INFO]
[INFO] >>> javadoc:3.2.0:javadoc (default-cli) > generate-sources @ systemds
>>>
[INFO]
[INFO] --- enforcer:1.4.1:enforce (enforce-maven-version) @ systemds ---
[INFO]
[INFO] --- enforcer:1.4.1:enforce (enforce-java-version) @ systemds ---
[INFO]
[INFO] --- enforcer:1.4.1:enforce (enforce-output-timestamp-property) @
systemds ---
[INFO]
[INFO] --- jacoco:0.8.10:prepare-agent (default-prepare-agent) @ systemds ---
[INFO] argLine set to
-javaagent:/home/codespace/.m2/repository/org/jacoco/org.jacoco.agent/0.8.10/org.jacoco.agent-0.8.10-runtime.jar=destfile=/workspaces/systemds/target/jacoco.exec,includes=**,output=file
-Xms3000m -Xmx3000m -Xmn300m
[INFO]
[INFO] <<< javadoc:3.2.0:javadoc (default-cli) < generate-sources @ systemds
<<<
[INFO]
[INFO]
[INFO] --- javadoc:3.2.0:javadoc (default-cli) @ systemds ---
[INFO] No previous run data found, generating javadoc.
[INFO]
------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO]
------------------------------------------------------------------------
[INFO] Total time: 44.158 s
[INFO] Finished at: 2024-02-11T17:19:24Z
[INFO]
------------------------------------------------------------------------
Running Sphinx v7.2.6
building [mo]: targets for 0 po files that are out of date
writing output...
building [html]: targets for 18 source files that are out of date
updating environment: [new config] 18 added, 0 changed, 0 removed
reading sources... [100%] index
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
copying assets... copying static files... done
copying extra files... done
done
writing output... [100%] index
generating indices... genindex py-modindex done
writing additional pages... search done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded.
The HTML pages are in build/html.
```
--
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: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
