Latest commit ac5364b Jan 24, 2017 @dkleikesa dkleikesa committed with piiswrong add docs/get_started/index_zh.md (#4788)
* add  docs/get_started/index_zh.md

* remove white space
Permalink
..
Failed to load latest commit information.
_static Making spelling and general grammar corrections (#4771) Jan 23, 2017
api Making spelling and general grammar corrections (#4771) Jan 23, 2017
architecture Making spelling and general grammar corrections (#4771) Jan 23, 2017
community Making spelling and general grammar corrections (#4771) Jan 23, 2017
get_started add docs/get_started/index_zh.md (#4788) Jan 24, 2017
how_to Making spelling and general grammar corrections (#4771) Jan 23, 2017
model_zoo Making spelling and general grammar corrections (#4771) Jan 23, 2017
packages Grammar and language correction to pages under architecture. Fixing b… Nov 17, 2016
system Grammar and language correction to pages under architecture. Fixing b… Nov 17, 2016
tutorials Add tutorial link to index. (#4784) Jan 24, 2017
zh update docs && fix typos (#4624) Jan 10, 2017
.dockerignore Dockerfile for building and previewing docs locally. Aug 5, 2016
.gitignore [DOC] Fix doxygen May 8, 2016
Dockerfile Dockerfile for building and previewing docs locally. Aug 5, 2016
Doxyfile [DOC] Fix doxygen May 8, 2016
Makefile Auto indexing for generated module docs. Apr 17, 2016
README.md Making spelling and general grammar corrections (#4771) Jan 23, 2017
build-notebooks.sh adding link to mxnet-notebooks to generated tutorials (#3926) Nov 21, 2016
build-preview.sh Dockerfile for building and previewing docs locally. Aug 5, 2016
conf.py [RELEASE] v0.9.3 official release (#4767) Jan 22, 2017
index.md Making spelling and general grammar corrections (#4771) Jan 23, 2017
requirements.txt [docs] add favicon and fix index html title Mar 25, 2016
sphinx_util.py fixing typo in the R manual command (#4445) Dec 30, 2016

README.md

MXNet documentation

A built version of document is available at http://mxnet.io

To build the docs with Docker

The Dockerfile in this directory encapsulates all the dependencies needed to build the docs. The default entry-point builds the docs and serves them through a simple HTTP server for previewing.

docker build -t mxnet/docs .
docker run -it -p 8008:8008 mxnet/docs
open http://localhost:8008/

Faster iterative development

If you are working on the docs and want to rebuild them without creating a new docker image each time, you can do this with

docker run -it -p 8008:8008 -v `pwd`:/opt/mxnet/docs mxnet/docs

which maps your current directory into the docker image to get any local changes.

NOTE: Any changes to the API reference will not get rebuilt this way. The API reference docs are introspected from the built binaries, which in this Dockerfile are pulled from github/dmlc/master. To work-around this, map a volume with your code changes into the container, and rebuild MXNet in the container before doing the doc build. Or use the local build described below.

Local build

To build the documentation without docker on your local machine, first install the required packages for Ubuntu 14.04. These are approximately:

sudo apt-get install doxygen python-pip
sudo pip install sphinx==1.3.5 CommonMark==0.5.4 breathe mock==1.0.1 recommonmark

(Refer to the Dockerfile for a more reliable description of the dependencies.) Once the MXNet binaries are built, and you have the dependencies installed, you can build the docs with:

make html