make docs from the MXNet root is the quickest way to generate the MXNet API docs and the website, as long as you already have all of the dependencies installed. This method automatically generates each API, except the Perl and R APIs.
Easy docs setup for Ubuntu: Run the following on Ubuntu 16.04 to install all MXNet and docs dependencies and to build MXNet from source. Then issue the
make docs command from the source root to build the docs.
git clone --recursive https://github.com/apache/incubator-mxnet.git mxnet cd mxnet/docs/build_version_doc ./setup_docs_ubuntu.sh cd ../../ make docs USE_OPENMP=1 SPHINXOPTS=-W
OpenMP speeds things up and will work on Ubuntu if you used the
setup_docs_ubuntu.sh script. The
-W Sphinx option enforces “warnings as errors”. This will help you debug your builds and get them through CI. CI will not let a PR through if it breaks the website. Refer to the MXNet Developer wiki's documentation guide for troubleshooting tips.
For more information on each API's documentation dependencies, how to serve the docs, or how to build the full website with each legacy MXNet version, refer to the following links:
_static/mxnet.csscontains all MXNet website styles
Page contents originate as markdown files. Sphinx converts markdown files to html through an
rst intermediate format. Each content folder should contain an index file as landing page.
There are some utility scripts to help building website, such as
build_version_doc/. They are used to manipulate website contents during building. Refer to Developer Build Instructions for more information.
Apache Jenkins MXNet website building job is used to build MXNet website.
restricted website build.
Build with Parameters.
restricted website buildit followed up with
restricted website publishwhich pushed the changes to the incubator-mxnet-site repo.
IMPORTANT: Refer to Full Site Build Instructions for a working site build with the versions dropdown in the UI.
make cleanand then