tree: 0d107807da9745faf1b609e44f3f457bea8a5410 [path history] [tgz]
  1. .dockerignore
  2. .gitignore
  3. Dockerfile
  4. Doxyfile
  5. Makefile
  6. README.md
  7. _static/
  8. api/
  9. architecture/
  10. build_version_doc/
  11. community/
  12. conf.py
  13. get_started/
  14. how_to/
  15. index.md
  16. model_zoo/
  17. mxdoc.py
  18. tutorials/
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.