Page History

...

Step 1 - You first need have build the MXNet binary (that matches what you have checked out). The following will generate the binaries that will be found in `/lib/` in your local MXNet repo folder. The different docs sets will be looking for the binary there.```bash

ci/build.py --docker-registry mxnetci --platform ubuntu_cpu_lite /work/runtime_functions.sh build_ubuntu_cpu_docs

```Step 2 -  Generate the doc set that you require. The following example generates Python docs in your local `docs/_build/` folder.```bash

ci/build.py --docker-registry mxnetci --platform ubuntu_cpu_python /work/runtime_functions.sh build_python_docs

...

Troubleshooting - You can interact with the Docker container, make changes, and force a rebuild of the docs. ```bash

docker run -v /home/ubuntu/incubator-mxnet:/work/mxnet -u 1000:1000 -ti mxnetci/build.ubuntu_cpu_python bash

...

You must adjust the folder mapping in the command to match wherever you're running the MXNet from. 

Once inside the container you can trigger another build by calling a function from runtime_functions.sh directly. For example:```bash#

ci/docker/runtime_functions.sh build_python_docs

```

or directly running

```

pushd docs/python_docs

...

eval "$(/work/miniconda/bin/conda shell.bash hook)"

...

conda env create -f environment.yml -p /work/conda_env

...

conda activate /work/conda_env

...

pip install themes/mx-theme

...

pip install -e /work/mxnet/python --user

...

pushd python

...

make clean

...

make html EVAL=0

...

To fully emulate the Jenkinsfile that generates the website, you may call each runtime_function for each docs package and for the Jekyll site then deploy the contents of your `docs/_build/` folder.

...