Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
## Summary This PR adds a new script, `rapids-upload-docs`. The purpose of this script is to consolidate the logic for uploading documentation to S3. This will be useful for the upcoming two efforts: - enabling documentation files to be previewed on PRs - temporarily halting documentation uploads to the `rapidsai-docs` bucket while we restructure the bucket in anticipation of some upcoming website changes ## Usage The snippet below shows how the script can be used. It requires two environment variables be set: - `RAPIDS_VERSION_NUMBER` - a RAPIDS version (e.g. `23.06`) - `RAPIDS_DOCS_DIR` - a path to a directory containing the docs to upload (see folder structure below) ```sh export RAPIDS_VERSION_NUMBER="23.06" export RAPIDS_DOCS_DIR=${RAPIDS_DOCS_DIR:-"${PWD}/documentation"} rapids-logger "Build cuDF Sphinx docs" pushd docs/cudf sphinx-build -b dirhtml source _html sphinx-build -b text source _text mkdir -p "${RAPIDS_DOCS_DIR}/cudf/{html,txt}" mv _html/* "${RAPIDS_DOCS_DIR}/cudf/html" mv _text/* "${RAPIDS_DOCS_DIR}/cudf/txt" popd rapids-logger "Build dask-cuDF Sphinx docs" pushd docs/dask_cudf sphinx-build -b dirhtml source _html sphinx-build -b text source _text mkdir -p "${RAPIDS_DOCS_DIR}/dask-cudf/{html,txt}" mv _html/* "${RAPIDS_DOCS_DIR}/dask-cudf/html" mv _text/* "${RAPIDS_DOCS_DIR}/dask-cudf/txt" popd rapids-upload-docs ``` The structure of `RAPIDS_DOCS_DIR` should look like this: ``` $RAPIDS_DOCS_DIR ├── cudf │ ├── html │ │ └── <html files> │ └── txt │ └── <txt files> └── dask-cudf ├── html │ └── <html files> └── txt └── <txt files> ```
- Loading branch information