diff --git a/tools/rapids-upload-docs b/tools/rapids-upload-docs index a0b83c0..b0ef118 100755 --- a/tools/rapids-upload-docs +++ b/tools/rapids-upload-docs @@ -1,4 +1,20 @@ #!/bin/bash +# This script uploads RAPIDS docs to S3. +# The docs are expected to be in the following directory structure: +# $RAPIDS_DOCS_DIR +# ├── cudf +# │ ├── html +# │ │ └── +# │ └── txt +# │ └── +# └── dask-cudf +# ├── html +# │ └── +# └── txt +# └── +# Required Environment Variables: +# - RAPIDS_DOCS_DIR - a path to a directory containing the docs to upload +# - RAPIDS_VERSION_NUMBER - the version number of the docs being uploaded set -euo pipefail checks() { @@ -9,6 +25,9 @@ checks() { if [[ "${GITHUB_ACTIONS:-false}" != "true" ]]; then echo "Uploading docs from local builds is not supported." + echo "The docs are in ${RAPIDS_DOCS_DIR}." + echo "They can be viewed in a web browser by running:" + echo "python -m http.server --directory ${RAPIDS_DOCS_DIR}" exit 0 fi