Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
4 changes: 2 additions & 2 deletions .github/workflows/deploy-cudf-java-docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,8 @@ jobs:
exit 1
fi

sed -i '/cudf-java:/,/stable:/s/stable: .*/stable: '"$NEW_STABLE_VALUE"'/' source/_data/docs.yml
echo "Updated stable value for cudf-java to $NEW_STABLE_VALUE in source/_data/docs.yml"
sed -i '/cudf-java:/,/stable:/s/stable: .*/stable: '"$NEW_STABLE_VALUE"'/' _data/docs.yml
echo "Updated stable value for cudf-java to $NEW_STABLE_VALUE in _data/docs.yml"

jq --arg version "$VERSION" '."cudf-java".stable = $version' ci/customization/projects-to-versions.json > tmp.json \
&& mv tmp.json ci/customization/projects-to-versions.json
Expand Down
16 changes: 8 additions & 8 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,14 @@ repos:
- id: trailing-whitespace
exclude: |
(?x)^(
source/assets/.*|
source/licenses/.*
assets/.*|
licenses/.*
)
- id: end-of-file-fixer
exclude: |
(?x)^(
source/assets/.*|
source/licenses/.*
assets/.*|
licenses/.*
)
- id: mixed-line-ending
- id: debug-statements
Expand All @@ -31,7 +31,7 @@ repos:
- id: check-json
exclude: |
(?x)^(
source/assets/.*|
assets/.*|
.devcontainer/devcontainer.json
)
- id: check-yaml
Expand All @@ -50,8 +50,8 @@ repos:
- id: fix-smartquotes
exclude: |
(?x)^(
source/assets/.*|
source/licenses/.*
assets/.*|
licenses/.*
)
- repo: https://github.com/codespell-project/codespell
rev: v2.4.2
Expand All @@ -60,7 +60,7 @@ repos:
types: [markdown]
exclude: |
(?x)^(
source/resources/conduct\.md
resources/conduct\.md
)$
- repo: https://github.com/astral-sh/ruff-pre-commit
rev: v0.15.9
Expand Down
File renamed without changes.
7 changes: 3 additions & 4 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ clean:
rm -rf _site

html: clean
$(UV) run sphinx-build -E -b dirhtml source _site -W --keep-going -n
$(UV) run sphinx-build -E -b dirhtml -c sphinx . _site -W --keep-going -n

assemble:
$(UV) run bash ci/download_from_s3.sh
Expand All @@ -18,15 +18,14 @@ assemble:
full: html assemble

lint:
$(UV) run ruff check ci extensions scripts source/conf.py tests
$(UV) run ruff format --check ci extensions scripts source/conf.py tests
$(UV) run ruff check ci extensions scripts sphinx/conf.py tests
$(UV) run ruff format --check ci extensions scripts sphinx/conf.py tests

test:
$(UV) run pytest

validate:
$(UV) run python scripts/validate_site.py _site
$(UV) run python scripts/compare_routes.py tests/fixtures/jekyll_manifest.json _site

check: lint test html validate

Expand Down
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,9 @@ production site.

## Repository layout

- `source/` contains the portal content, Sphinx configuration, static assets,
and data files.
- Portal content, data, includes, and assets retain their established paths at
the repository root.
- `sphinx/` contains the Sphinx configuration, templates, and theme overrides.
- `extensions/` contains the portal's data-rendering and publication extension.
- `ci/` downloads and post-processes versioned API and deployment documentation.
- `scripts/` and `tests/` validate rendered routes, content, and publication
Expand All @@ -57,5 +58,3 @@ production site.

The Sphinx portal was initially migrated from the Jekyll site at
[`rapidsai/docs@b6afa0c`](https://github.com/rapidsai/docs/commit/b6afa0cbf4ddfc4c0a21f7c79b18631f214fd759).
The route and content fixture in `tests/fixtures/jekyll_manifest.json` preserves
that publication baseline.
2 changes: 1 addition & 1 deletion source/_data/docs.yml → _data/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ apis:
cllink: https://github.com/rapidsai/ucxx/blob/main/CHANGELOG.md
versions:
# enable or disable links; 0 = disabled, 1 = enabled
# TODO: enable 'legacy' once ucxx legacy version moves to 0.46 in `source/_data/releases.json`
# TODO: enable 'legacy' once ucxx legacy version moves to 0.46 in `_data/releases.json`
legacy: 0
stable: 1
nightly: 1
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
/* SPDX-FileCopyrightText: Copyright (c) 2024-2025, NVIDIA CORPORATION & AFFILIATES.
* All rights reserved.
* SPDX-License-Identifier: Apache-2.0 */

/*! normalize.scss v0.1.0 | MIT License | based on git.io/normalize */
/**
* 1. Set default font family to sans-serif.
Expand Down Expand Up @@ -994,7 +994,7 @@ li .highlight {
@media (min-width: 50rem) {
.search {
margin-bottom: 0; } }

.search-input-wrap {
display: flex;
height: 100%;
Expand All @@ -1011,7 +1011,7 @@ li .highlight {
background-color: #fff;
border-radius: 0;
box-shadow: none; } }

.search-input {
align-self: center;
width: 100%;
Expand Down Expand Up @@ -1039,13 +1039,13 @@ li .highlight {
@media (min-width: 50rem) and (min-width: 31.25rem) {
.search-input {
font-size: 14px !important; } }

.search-icon {
align-self: center;
margin-right: 0.5rem;
fill: #959396;
order: 1; }

.search-results-wrap {
position: absolute;
z-index: 100;
Expand All @@ -1059,7 +1059,7 @@ li .highlight {
@media (min-width: 50rem) {
.search-results-wrap {
width: 500px; } }

.search-results-list {
padding-left: 0;
margin-top: 0.25rem;
Expand All @@ -1075,11 +1075,11 @@ li .highlight {
@media (min-width: 50rem) and (min-width: 31.25rem) {
.search-results-list {
font-size: 14px !important; } }

.search-results-list-item {
padding: 0;
margin: 0; }

.search-result {
display: block;
padding-top: 0.25rem;
Expand All @@ -1092,7 +1092,7 @@ li .highlight {
.search-result {
padding-right: 1rem;
padding-left: 1rem; } }

.search-result-title {
display: block;
padding-top: 0.5rem;
Expand All @@ -1104,7 +1104,7 @@ li .highlight {
width: 40%;
word-wrap: break-word;
vertical-align: top; } }

.search-result-rel-url {
display: block;
overflow: hidden;
Expand All @@ -1115,7 +1115,7 @@ li .highlight {
@media (min-width: 31.25rem) {
.search-result-rel-url {
font-size: 10px !important; } }

.search-result-preview {
display: block;
padding-top: 0.5rem;
Expand All @@ -1133,7 +1133,7 @@ li .highlight {
display: inline-block;
width: 60%;
vertical-align: top; } }

.search-result-highlight {
font-weight: bold;
color: #7253ed; }
Expand Down
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
Loading