aaronmarkham opened a new pull request #9878: Docs build all versions refactor URL: https://github.com/apache/incubator-mxnet/pull/9878 ## Description ## I updated the build_all_versions.sh logic so that it works locally and can possibly repair the docs site when the version builds are broken. ## Checklist ## ### Essentials ### - [ ] Passed code style checking (`make lint`) - [ ] Changes are complete (i.e. I finished coding on this PR) - [ ] All changes have test coverage: - Unit tests are added for small changes to verify correctness (e.g. adding a new operator) - Nightly tests are added for complicated/long-running ones (e.g. changing distributed kvstore) - Build tests will be added for build configuration changes (e.g. adding a new build option with NCCL) - [ ] Code is well-documented: - For user-facing API changes, API doc string has been updated. - For new C++ functions in header files, their functionalities and arguments are documented. - For new examples, README.md is added to explain the what the example does, the source of the dataset, expected performance on test set and reference to the original paper if applicable - [x] To the my best knowledge, examples are either not affected by this change, or have been fixed to be compatible with this change ### Changes ### * I created a setup script (setup.sh) to handle all of the deps that were missing from the documentation - for an ubuntu setup. * I split out the docker setup to another script (setup_docker.sh) since the directions for this work, but they only help you create a local version of master and not the production style "versioned" site. * I split the logic in build_all_version.sh which is build and then update (injecting dom elements like the version dropdown) to be just build, and then created another script (update_all_version.sh) to handle the updates. This way you can build everything, then test how the injection stuff works. Otherwise, for every change you're forced to rebuild each version, which is crazy slow. - The logic also had you check out from master and then use the scripts within master to do the updating. This makes it hard to test changes you want to make, so I moved this logic to using your current modified local version, and then update the temp build directories. - The files mixed up the tag list naming convention, so I made sure it is always tag_list.txt and not tag.txt sometimes. ## Usage ## Use an Ubuntu image. I'm using Deep Learning AMI v5. ``` ./setup.sh ./build_all_version.sh ./update_all_version.sh ``` The run a server on the outputted `VersionedWeb` folder. ## Comments ## Please help me test this out and let me know what suggestions you have.
---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
