use rapids-upload-docs script #1288
Conversation
AyodeAwe
added
non-breaking
ci/build_docs.sh
Outdated
| @@ -26,22 +26,23 @@ rapids-mamba-retry install \ | |||
| --channel "${PYTHON_CHANNEL}" \ | |||
| rmm librmm | |||
|
|
|||
| # Build CPP docs | |||
| rapids-logger "Build Doxygen docs" | |||
| export RAPIDS_VERSION_NUMBER=${VERSION_NUMBER} | |||
There was a problem hiding this comment.
| export RAPIDS_VERSION_NUMBER=${VERSION_NUMBER} | |
| export RAPIDS_VERSION_NUMBER=23.08 |
the VERSION_NUMBER line can now be removed. it was only ever used in the aws s3... commands which are removed in your PR.
please remember to also update the corresponding entry in update-version.sh.
ci/build_docs.sh
Outdated
| rapids-logger "Build Python docs" | ||
| pushd python/docs | ||
| sphinx-build -b dirhtml . _html | ||
| sphinx-build -b text . _text | ||
| mkdir -p "${RAPIDS_DOCS_DIR}/rmm/{html,txt}" |
There was a problem hiding this comment.
| mkdir -p "${RAPIDS_DOCS_DIR}/rmm/{html,txt}" | |
| mkdir -p "${RAPIDS_DOCS_DIR}/rmm/"{html,txt} |
We'll need to uncomment the {} for this expansion to work properly.
ci/build_docs.sh
Outdated
| # Build CPP docs | ||
| rapids-logger "Build Doxygen docs" | ||
| export RAPIDS_VERSION_NUMBER="23.08" | ||
| export RAPIDS_DOCS_DIR=${RAPIDS_DOCS_DIR:-"${PWD}/documentation"} |
There was a problem hiding this comment.
| export RAPIDS_DOCS_DIR=${RAPIDS_DOCS_DIR:-"${PWD}/documentation"} | |
| export RAPIDS_DOCS_DIR="$(mktemp -d)" |
In hindsight, we can just make this variable a temporary directory.
I originally thought it would be useful to set this environment variable at the shared-workflow level, but the variable's value is only ever used in this particular workflow step.
Therefore we don't need to set it at the workflow level and can simply set it in this script.
I will also open a PR to revert rapidsai/shared-workflows#93.
There was a problem hiding this comment.
Reverted in rapidsai/shared-workflows#107.
|
/merge |
As noted in rapidsai/rmm#1288, the value of `RAPIDS_DOCS_DIR` is random and generated by `mktemp -d`. Therefore, it will be useful to print out this directory for users who are doing local builds according to the repro instructions here: https://docs.rapids.ai/resources/reproducing-ci/. Additionally, a `python -m http.server` command is printed so that users can view the built docs in their browser.
This PR updates the
build_docs.shscript to use the new consolidatoryrapids-upload-scriptshared script.The shared script enables docs uploads to applicable S3 buckets for branch. nightly and PR builds.