-
Notifications
You must be signed in to change notification settings - Fork 6.8k
add binary and docs build command options to devmenu #16514
Conversation
@larroy Can you review? |
@@ -132,8 +132,24 @@ def provision_virtualenv(venv_path=DEFAULT_PYENV): | |||
('[Local] Python Unit tests', | |||
"./py3_venv/bin/nosetests -v tests/python/unittest/" | |||
), | |||
('[Docker] Website and docs build outputs to "docs/_build/html/"', | |||
"ci/build.py --platform ubuntu_cpu /work/runtime_functions.sh deploy_docs"), | |||
('[Docker] Build the MXNet binary - outputs to "lib/"', |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
mxnet binary? not clear what this does.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It builds the .so and .a file that the docs need for API docs generation.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
only the .so file is needed AFAIK
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
could you explain tradeoff / motivation between building all docs or one by one?
CI was updated to parallelize the docs generation. It cut the build time in half. While you can build them manually, using docker and the same flow as CI helps consolidate any issues and helps with troubleshooting. Also, contributors that focus on one language binding now can do just that, rather than needing to use Sphinx/Python to get their docs generated. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Description
This PR will make it easier for users/contributors to build MXNet from source and then build any documentation set they need.
Prerequisites
pip3
(this script isn't compatible with Python 2.x)Usage
Go to the root of the repo then run:
It'll look like this:
This PR adds options 3-11.
With the exception of Jekyll, the other documentation sets are likely going to need you to build the MXNet binary first (running option
3
). But only once. When the binary is there, you can run the rest of the doc sets.