tree: bf8fdb00f39010b5e0166be6a12aeae62fda72ce [path history] [tgz]
  1. _static/
  2. api/
  3. architecture/
  4. community/
  5. get_started/
  6. how_to/
  7. model_zoo/
  8. packages/
  9. system/
  10. tutorials/
  11. zh/
  12. .dockerignore
  13. .gitignore
  14. build-notebooks.sh
  15. build-preview.sh
  16. conf.py
  17. Dockerfile
  18. Doxyfile
  19. index.md
  20. Makefile
  21. README.md
  22. requirements.txt
  23. sphinx_util.py
docs/README.md

MXNet documentation

MXNet's documents can be built by running make html in this folder.

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

To build the documents locally, the easiest way is by using docker. First make sure docker is installed. Then use the following commands to clone and build MXNet's documents (not including jupyter notebooks and API documents execept for Python):

git clone --recursive https://github.com/dmlc/mxnet
cd mxnet
tests/ci_build/ci_build.sh doc DEV=1 make -C docs/ html

The built documents will be available at docs/_build/html/.

Note:

  • If C++ codes have been changed, we suggest to remove the previous results before building, namely run rm -rf docs/_build/html/.

  • If CSS or javascript are changed, we often need to do a force refresh in the browser to clear the cache.