Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add message about viewing docs locally to rapids-upload-docs #58

Merged
merged 2 commits into from
Jun 5, 2023
Merged

Add message about viewing docs locally to rapids-upload-docs #58

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0602a2e
add msg about viewing docs locally
ajschmidt8 Jun 5, 2023
3dcb3fd
add usage comment
ajschmidt8 Jun 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions tools/rapids-upload-docs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
# │ │ └── <html files>
# │ └── txt
# │ └── <txt files>
# └── dask-cudf
# ├── html
# │ └── <html files>
# └── txt
# └── <txt files>
# 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() {
Expand All @@ -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

Expand Down