Skip to content

docs: add pixi docs env and clean repo-owned warnings#1870

Merged
cpcloud merged 4 commits intoNVIDIA:mainfrom
cpcloud:cleanup-docs-warnings
Apr 8, 2026
Merged

docs: add pixi docs env and clean repo-owned warnings#1870
cpcloud merged 4 commits intoNVIDIA:mainfrom
cpcloud:cleanup-docs-warnings

Conversation

@cpcloud
Copy link
Copy Markdown
Contributor

@cpcloud cpcloud commented Apr 7, 2026

Summary

  • add Pixi-managed docs environments/tasks for the repo root, cuda_pathfinder, cuda_bindings, and cuda_core
  • fix repo-owned docs warnings in cuda_pathfinder and cuda_core
  • fix source-owned cuda_bindings docs/config warnings without patching generated module docs

Scope

  • this PR does not modify generated cuda_bindings module docs such as docs/source/module/driver.rst and docs/source/module/runtime.rst
  • the remaining cuda_bindings warnings come from generated module docs and are left for follow-up in the code generator flow
  • the cuda_bindings docs env uses released cuda-bindings = "13.2.*" because the local editable build currently fails before Sphinx runs

Validation

  • pixi run -e docs docs
  • pixi run -e docs docs-pathfinder
  • pixi run -e docs docs-core
  • pixi run -e docs docs-bindings

Current results

  • cuda_pathfinder: docs build succeeds with no warnings
  • cuda_core: docs build succeeds with no warnings
  • cuda_bindings: docs build succeeds; generated module warnings remain

Made with Cursor

@cpcloud cpcloud added this to the cuda.core v1.0.0 milestone Apr 7, 2026
@cpcloud cpcloud added documentation Improvements or additions to documentation cuda.bindings Everything related to the cuda.bindings module cuda.core Everything related to the cuda.core module cuda.pathfinder Everything related to the cuda.pathfinder module labels Apr 7, 2026
@cpcloud cpcloud self-assigned this Apr 7, 2026
@github-actions

This comment has been minimized.

@cpcloud cpcloud requested a review from rparolin April 7, 2026 15:42
@cpcloud cpcloud force-pushed the cleanup-docs-warnings branch from 0b8b7ad to 47ed4fb Compare April 8, 2026 11:28
cpcloud added 4 commits April 8, 2026 07:42
Add reproducible Pixi docs workflows for pathfinder, bindings, and core, and fix the warnings in source-owned docs and shared Sphinx extensions. Keep generated bindings module docs out of scope so the remaining warning set stays isolated to code generator output.

Made-with: Cursor
Apply the formatter changes required by pre-commit.ci so the docs helper updates match repository formatting rules.

Made-with: Cursor
Enable `-W --keep-going` for the pathfinder and core Sphinx builds so warning regressions fail the docs workflow while still reporting the full warning set.

Made-with: Cursor
Remove the redundant cuda_core build-docs alias and point the repo-root docs task at the canonical docs-build target so the post-rebase docs workflow stays consistent.

Made-with: Cursor
@cpcloud cpcloud force-pushed the cleanup-docs-warnings branch from 47ed4fb to 4ea7469 Compare April 8, 2026 12:31
@cpcloud cpcloud enabled auto-merge (squash) April 8, 2026 12:39
@cpcloud cpcloud merged commit c3e1180 into NVIDIA:main Apr 8, 2026
87 checks passed
@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 8, 2026

Doc Preview CI
Preview removed because the pull request was closed or merged.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cuda.bindings Everything related to the cuda.bindings module cuda.core Everything related to the cuda.core module cuda.pathfinder Everything related to the cuda.pathfinder module documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants