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.

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

chore(ci): Build docs #78

Open
wants to merge 14 commits into
base: main
Choose a base branch
from
7 changes: 7 additions & 0 deletions .github/workflows/build-test.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,13 @@ jobs:
with:
name: conda_artifacts
path: ${{ env.OUTPUT_DIR }}
docs-build:
if: github.ref_type == 'branch'
needs: conda
runs-on: ubuntu-latest
container: rapidsai/ci-conda:latest
steps:
- run: ./ci/build_docs.sh
KyleFromNVIDIA marked this conversation as resolved.
Show resolved Hide resolved
wheel:
runs-on: ubuntu-latest
container: python:3
Expand Down
41 changes: 41 additions & 0 deletions ci/build_docs.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
#!/bin/bash
# Copyright (c) 2023-2024, NVIDIA CORPORATION.

set -euo pipefail

rapids-logger "Create test conda environment"
. /opt/conda/etc/profile.d/conda.sh

ENV_YAML_DIR="$(mktemp -d)"

rapids-dependency-file-generator \
--output conda \
--file_key docs | tee "${ENV_YAML_DIR}/env.yaml"

rapids-mamba-retry env create --yes -n docs
conda activate docs

rapids-print-env

rapids-logger "Downloading artifacts from previous jobs"
PYTHON_CHANNEL=$(rapids-download-conda-from-s3 python)
KyleFromNVIDIA marked this conversation as resolved.
Show resolved Hide resolved

rapids-mamba-retry install \
--channel "${PYTHON_CHANNEL}" \
rapids-dependency-file-generator

export RAPIDS_DOCS_DIR="$(mktemp -d)"

rapids-logger "Build rapids-dependency-file-generator Sphinx docs"
pushd docs
make dirhtml
mkdir -p "${RAPIDS_DOCS_DIR}/rapids-dependency-file-generator/html"
mv build/dirhtml/* "${RAPIDS_DOCS_DIR}/rapids-dependency-file-generator/html"
if [[ "${RAPIDS_BUILD_TYPE}" != "pull-request" ]]; then
make text
mkdir -p "${RAPIDS_DOCS_DIR}/rapids-dependency-file-generator/txt"
mv build/text/* "${RAPIDS_DOCS_DIR}/rapids-dependency-file-generator/txt"
fi
popd

rapids-upload-docs
2 changes: 0 additions & 2 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,6 @@
"navbar_align": "right",
}

html_static_path = ["_static"]

# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]

Expand Down
Loading