Repository: systemml Updated Branches: refs/heads/gh-pages 4e22b91ea -> 288bc35c3
[SYSTEMML-1860] Update release-process for python doc and add api menu item Closes #648. Project: http://git-wip-us.apache.org/repos/asf/systemml/repo Commit: http://git-wip-us.apache.org/repos/asf/systemml/commit/24245fd5 Tree: http://git-wip-us.apache.org/repos/asf/systemml/tree/24245fd5 Diff: http://git-wip-us.apache.org/repos/asf/systemml/diff/24245fd5 Branch: refs/heads/gh-pages Commit: 24245fd5ec5ac288bc3b2599ef3892a269e33ccc Parents: 4e22b91 Author: Glenn Weidner <gweid...@us.ibm.com> Authored: Thu Aug 31 16:16:39 2017 -0700 Committer: Glenn Weidner <gweid...@us.ibm.com> Committed: Thu Aug 31 16:16:39 2017 -0700 ---------------------------------------------------------------------- _layouts/global.html | 3 ++- release-process.md | 18 ++++++++++++++++-- 2 files changed, 18 insertions(+), 3 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/systemml/blob/24245fd5/_layouts/global.html ---------------------------------------------------------------------- diff --git a/_layouts/global.html b/_layouts/global.html index 5e84276..4286c9c 100644 --- a/_layouts/global.html +++ b/_layouts/global.html @@ -77,7 +77,8 @@ <li class="dropdown"> <a href="#" class="dropdown-toggle" data-toggle="dropdown">API Docs<b class="caret"></b></a> <ul class="dropdown-menu" role="menu"> - <li><a href="./api/java/index.html">Javadoc</a></li> + <li><a href="./api/java/index.html">Java</a></li> + <li><a href="./api/python/index.html">Python</a></li> </ul> </li> {% endif %} http://git-wip-us.apache.org/repos/asf/systemml/blob/24245fd5/release-process.md ---------------------------------------------------------------------- diff --git a/release-process.md b/release-process.md index 4a31f8b..d8d74f4 100644 --- a/release-process.md +++ b/release-process.md @@ -204,7 +204,7 @@ this OS X example. ./runStandaloneSystemML.sh hello.dml cd .. - # verify standalon zip works + # verify standalone zip works rm -rf systemml-1.0.0-bin unzip systemml-1.0.0-bin.zip cd systemml-1.0.0-bin @@ -428,6 +428,7 @@ Copy contents of `systemml/docs/_site` to `systemml-website-site/docs/1.0.0`. Delete any unnecessary files (`Gemfile`, `Gemfile.lock`). Create `systemml-website-site/docs/1.0.0/api/java` folder for javadocs. +Create `systemml-website-site/docs/1.0.0/api/python` folder for pythondocs. Update `systemml/pom.xml` project version to what should be displayed in javadocs (such as `1.0.0`). @@ -437,7 +438,20 @@ Build project (which generates javadocs). Copy contents of `systemml/target/apidocs` to `systemml-website-site/docs/1.0.0/api/java`. -Open up `file:///.../systemml-website-site/docs/1.0.0/index.html` and verify `API Docs` → `Javadoc` link works and that the correct Javadoc version is displayed. Verify feedback links under `Issues` menu are not present. +Define environment variables to match version and release number used in updated `systemml/pom.xml`. Both environment variables are referenced when building pythondocs with Sphinx. + + $ export SYSTEMML_VERSION=1.0 + $ export SYSTEMML_RELEASE=1.0.0 + +Generate pythondocs with Sphinx. + + $ cd systemml/src/main/pythondoc + $ make html + +Copy contents of `systemml/target/pydocs/html` to `systemml-website-site/docs/1.0.0/api/python`. + +Open up `file:///.../systemml-website-site/docs/1.0.0/index.html` and verify `API Docs` → `Java` link works and that the correct Javadoc version is displayed. +Verify `API Docs` → `Python` link works and that the same Pythondoc version is displayed. Verify feedback links under `Issues` menu are not present. Clean up any unnecessary files (such as deleting `.DS_Store` files on OS X).
