DISCONTINUATION OF PROJECT. This project will no longer be maintained by Intel. Intel will not provide or guarantee development of or support for this project, including but not limited to, maintenance, bug fixes, new releases or updates. Patches to this project are no longer accepted by Intel. If you have an ongoing need to use this project, are interested in independently developing it, or would like to maintain patches for the community, please create your own fork of the project.
Do not delete this repository
The website is hosted at http://mxnet.incubator.apache.org/. http://mxnet.io redirects to this site and advised to use links with http://mxnet.incubator.apache.org/ instead of http://mxnet.io/.
MXNet Documentation Website is built with Sphinx and a variety of plugins including pandoc, recommonmark, a custom Sphinx plugin (mxdoc.py).
Using 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 files such as css, javascript and html templates are under the _static
folder:
_static/js
folder_static/mxnet-theme
folder_static/mxnet.css
contains all MXNet website stylesPage 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 mxdoc.py
and 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.
The Jenkins docs build job will fetch MXNet repository, build MXNet website and push all static files to host repository. The host repo is hooked with Apache gitbox to host website.
restricted website build
.Build with Parameters
.restricted website build
it followed up with restricted website publish
which 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 clean_docs
.make clean
.make clean
and then make docs
.