tree: 41ae00b06bafad917b21d66951a888d76e985015 [path history] [tgz]
  1. _static/
  2. api/
  3. architecture/
  4. community/
  5. get_started/
  6. how_to/
  7. model_zoo/
  8. tutorials/
  9. .dockerignore
  10. .gitignore
  11. conf.py
  12. Dockerfile
  13. Doxyfile
  14. index.md
  15. Makefile
  16. mxdoc.py
  17. README.md
docs/README.md

MXNet documentation

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

To build the documents locally, we need to first install docker. Then use the following commands to clone and build the documents.

git clone --recursive https://github.com/dmlc/mxnet
cd mxnet && make docs

The results will be available at docs/_build/html/.

Note:

  • If C++ codes have been changed, we suggest to remove the previous results to trigger the rebuild for all pages, namely run make clean_docs.
  • If C++ codes are failed 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.