Nightly build

versions/master/_sources/README.txt

@@ -1,5 +1,9 @@
 # MXNet documentation
 
+## How to build MXNet website
+
+MXNet Documentation Website is built with [sphinx 1.5.1](http://www.sphinx-doc.org/en/1.5.1/intro.html).
+
 A built version of document is available at http://mxnet.io
 
 To build the documents locally, we need to first install [docker](https://docker.com).
@@ -11,6 +15,12 @@ git clone --recursive https://github.com/apache/incubator-mxnet.git mxnet
 cd mxnet && make docs
 ```
 
+In case docker method is not available, there is an alternate method:
+```bash
+sudo pip install sphinx==1.5.1 CommonMark==0.5.4 breathe mock==1.0.1 recommonmark pypandoc
+cd mxnet/docs && make html USE_OPENMP=0
+```
+
 The results will be available at `docs/_build/html/`.
 
 Note:
@@ -20,3 +30,62 @@ Note:
 - If C++ code fails to build, run `make clean`
 - If CSS or javascript are changed, we often need to do a *force refresh* in the
   browser to clear the cache.
+- If search doesn't work, we need to `make clean` and rebuild.
+
+## File structure
+
+1. Static files such as css, javascript and html templates are under `_static` folder:
+- Javascript files are under `_static/js` folder.
+- Layout templates and landing page html file are under `_static/mxnet-theme` folder.
+- `_static/mxnet.css` contains all MXNet website styles.
+
+2. Sphinx converts markdowns files to html. Page contents are markdown files. Each content folder 
+contains an index file as landing page.
+
+3. There are some utility scripts to help building website, such as `mxdoc.py` and `build_version_doc/`.
+They are used to manipulate website contents during building.
+
+## Production website building process
+
+[Apache Jenkins MXNet website building job](https://builds.apache.org/job/incubator-mxnet-build-site/) is used to build MXNet website. 
+There are two ways to trigger this job. 
+First is nightly build for master branch. 
+Second is manually trigger job when a new version is released. This will build for new version.
+
+The job will fetch mxnet repository, build MXNet website and push all static files to [host repository](https://github.com/apache/incubator-mxnet-site.git). 
+The host repo is hooked with [Apache gitbox](https://gitbox.apache.org/repos/asf?p=incubator-mxnet-site.git;a=summary) to host website.
+
+## Build versioning website
+
+`make docs` doesn't add any version information. Version information is added by [Apache Jenkins MXNet website building job](https://builds.apache.org/job/incubator-mxnet-build-site/).
+Landing page will point to the latest released version. Older versions and master version are placed under versions folder. 
+After completing website update and testing it locally, we also need to build and test versioning website.
+
+Python Beautifulsoup is the dependency:
+
+```bash
+sudo pip install beautifulsoup4
+```
+
+The essenitial part of adding version is to use `AddPackageLink.py` to add Apache source packages and 
+`AddVersion.py` to update all version related information on website. These two scripts are used in `build_doc.sh` and `build_all_version`. 
+
+`build_doc.sh` is used by Apache Jenkins MXNet webiste building job to incremental adding version. We don't need it 
+for local website development. 
+
+`build_all_version.sh` is to rebuild versioning website locally and is useful to verify versioning website locally. 
+We need to specify which versions to be built. This can be set in `tag_list` variable at the beginning of the script. 
+Version order should be from latest to oldest and placing master at the end. We may also want to modify `mxnet_url` 
+variable to our own repository for local testing. Another use case is to completely rebuild website with specific versions. 
+Although this will not happen often, we can use it to rebuld whole website and push to [host repo](https://github.com/apache/incubator-mxnet-site.git).
+
+```bash
+./build_all_version.sh
+```
+
+## Develop notes
+
+1. `AddVersion.py` depends on Beautiful library, which requires target html files to have close tags. Although open tag html can still be rendered by browser, it will be problematic for Beautifulsoup. 
+
+2. `AddVersion.py` and `AddPackageLink.py` manipulates contents for website. If there are layout changes, it may break these two scripts. We need to change scripts respectively.
+

versions/master/_sources/api/julia/index.txt

@@ -1,5 +1,5 @@
-MXNet - Julia API
-=================
+# MXNet - Julia API
+
 MXNet supports the Julia programming language. The MXNet Julia package brings flexible and efficient GPU
 computing and the state-of-art deep learning to Julia.
 
@@ -10,4 +10,5 @@ computing and the state-of-art deep learning to Julia.
 
  
 
+## Julia API Reference
 Julia documents are available at [http://dmlc.ml/MXNet.jl/latest/](http://dmlc.ml/MXNet.jl/latest/).

versions/master/_sources/api/perl/index.txt

@@ -56,9 +56,9 @@ pdl> print mx->nd->array(sequence(2,3))->aspdl ## 3 rows, 2 columns
 ]
 ```
  ## Perl API Reference
- * [Module API](module.md) is a flexible high-level interface for training neural networks.
- * [Symbolic API](symbol.md) performs operations on NDArrays to assemble neural networks from layers.
- * [IO Data Loading API](io.md) performs parsing and data loading.
- * [NDArray API](ndarray.md) performs vector/matrix/tensor operations.
- * [KVStore API](kvstore.md) performs multi-GPU and multi-host distributed training.
+ * [Module API is a flexible high-level interface for training neural networks.](module.md)
+ * [Symbolic API performs operations on NDArrays to assemble neural networks from layers.](symbol.md)
+ * [IO Data Loading API performs parsing and data loading.](io.md)
+ * [NDArray API performs vector/matrix/tensor operations.](ndarray.md)
+ * [KVStore API performs multi-GPU and multi-host distributed training.](kvstore.md)
 

versions/master/_sources/api/python/index.txt

@@ -22,11 +22,16 @@ imported by running:
 ## Table of contents
 
 ```eval_rst
+.. toctree::
+   :maxdepth: 2
+   :titlesonly:
+
+   ndarray/index.md
+   symbol/index.md
+
 .. toctree::
    :maxdepth: 2
 
-   ndarray
-   symbol
    module
    autograd
    gluon

versions/master/_sources/api/python/ndarray/contrib.txt

@@ -0,0 +1,65 @@
+# Contrib NDArray API
+
+```eval_rst
+    .. currentmodule:: mxnet.ndarray.contrib
+```
+
+## Overview
+
+This document lists the contrib routines of the *n*-dimensional array package:
+
+```eval_rst
+.. autosummary::
+    :nosignatures:
+
+    mxnet.ndarray.contrib
+```
+
+The `Contrib NDArray` API, defined in the `ndarray.contrib` package, provides
+many useful experimental APIs for new features.
+This is a place for the community to try out the new features,
+so that feature contributors can receive feedback.
+
+```eval_rst
+.. warning:: This package contains experimental APIs and may change in the near future.
+```
+
+In the rest of this document, we list routines provided by the `ndarray.contrib` package.
+
+## Contrib
+
+```eval_rst
+.. currentmodule:: mxnet.ndarray.contrib
+
+.. autosummary::
+    :nosignatures:
+
+    CTCLoss
+    DeformableConvolution
+    DeformablePSROIPooling
+    MultiBoxDetection
+    MultiBoxPrior
+    MultiBoxTarget
+    MultiProposal
+    PSROIPooling
+    Proposal
+    count_sketch
+    ctc_loss
+    dequantize
+    fft
+    ifft
+    quantize
+```
+
+## API Reference
+
+<script type="text/javascript" src='../../_static/js/auto_module_index.js'></script>
+
+```eval_rst
+
+.. automodule:: mxnet.ndarray.contrib
+    :members:
+
+```
+
+<script>auto_index("api-reference");</script>

versions/master/_sources/api/python/ndarray/index.txt

@@ -0,0 +1,14 @@
+# NDArray API
+
+## Table of Content
+
+```eval_rst
+.. toctree::
+   :maxdepth: 2
+
+   ndarray.md
+   random.md
+   linalg.md
+   sparse.md
+   contrib.md
+```

versions/master/_sources/api/python/ndarray/linalg.txt

@@ -0,0 +1,53 @@
+# Linear Algebra NDArray API
+
+```eval_rst
+    .. currentmodule:: mxnet.ndarray.linalg
+```
+
+## Overview
+
+This document lists the linear algebra routines of the *n*-dimensional array package:
+
+```eval_rst
+.. autosummary::
+    :nosignatures:
+
+    mxnet.ndarray.linalg
+```
+
+The `Linear Algebra NDArray` API, defined in the `ndarray.linalg` package, provides
+imperative linear algebra tensor operations on CPU/GPU.
+
+In the rest of this document, we list routines provided by the `ndarray.linalg` package.
+
+## Linear Algebra
+
+```eval_rst
+.. currentmodule:: mxnet.ndarray.linalg
+
+.. autosummary::
+    :nosignatures:
+
+    gemm
+    gemm2
+    potrf
+    potri
+    trmm
+    trsm
+    sumlogdiag
+    syrk
+    gelqf
+```
+
+## API Reference
+
+<script type="text/javascript" src='../../_static/js/auto_module_index.js'></script>
+
+```eval_rst
+
+.. automodule:: mxnet.ndarray.linalg
+    :members:
+
+```
+
+<script>auto_index("api-reference");</script>