Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

If you have already built various versions and you don't want to recreate them, then don't do the delete step in the earlier example. Retain the website. Each version is in the website's /version folder. Also, each version that was built and pre-update is in the docs/build_version_doc/<fork-username> folder. You can also run the one-off site build using make html. Copy your newly created versions of the site into aptly named subfolders within the the docs/build_version_doc/<fork-username> folder. Then rerun update_all_version.sh with the versions you want to appear in the dropdown list. Take that output and serve it, or even make a new directory in /var/www/html/versions and copy it in there, so you can run many flavors of the site at will.

Troubleshooting

  • Sometimes the submodules get updated in master and you have to specifically update them yourself. If you see a build error that crashes on mshadow or another submodule's build you likely need to run the following command in your MXNet repo:
     git submodule update --init --recursive
  • Another more rare occurrence is someone did something fairly major and you get a build error in MXNet like "no rule to make target...". Try running the following in the MXNet repo root of the version that is failing:
     make clean
  • You might get nagged about a file that is going to get overwritten with a checkout when you've made local changes in your branch, but are trying to run a test build from the upstream branch. At this point it is better to set the build_all_version script to use your fork, so you can test it out.

Next up

Website Updating Guide

...