Skip to content

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented Aug 21, 2025

This PR implements comprehensive Sphinx documentation for cuda.pathfinder to replace the current README-only documentation approach.

Changes Made

Documentation Infrastructure

  • Created complete Sphinx documentation setup in cuda_pathfinder/docs/ following the established CUDA Python documentation patterns
  • Configured pathfinder-specific settings including project name, version environment variables, and URL paths
  • Set up version management with nv-versions.json containing version 1.1.0 and latest

Documentation Content

  • Main documentation includes the full cuda.pathfinder README content rendered as proper Sphinx documentation
  • Added comprehensive API reference with detailed documentation for all public APIs:
    • cuda.pathfinder.SUPPORTED_NVIDIA_LIBNAMES constant
    • cuda.pathfinder.load_nvidia_dynamic_lib() function
    • cuda.pathfinder.LoadedDL class
    • cuda.pathfinder.DynamicLibNotFoundError exception
  • Added release notes for versions 1.0.0 and 1.1.0 with content from GitHub releases
  • Maintained consistent styling and navigation with other CUDA Python component documentation

Integration Updates

  • Updated main CUDA Python documentation (cuda_python/docs/source/index.rst) to link to new Sphinx docs instead of raw README
  • Updated root README.md to point to the new documentation URL: https://nvidia.github.io/cuda-python/cuda-pathfinder/latest
  • Enhanced build_all_docs.sh script to include pathfinder documentation in the complete build process
  • Updated CI workflow (build-docs.yml) to handle cuda-pathfinder as both an individual component and part of the "all" components build
  • Updated doc preview CI to include cuda-pathfinder documentation links alongside cuda-core and cuda-bindings

Build System

  • Pathfinder documentation can now be built independently with ./build_docs.sh or as part of the complete documentation suite
  • Configured proper environment variable handling (SPHINX_CUDA_PATHFINDER_VER) for versioned builds
  • Set up redirection pages and version switching consistent with other components
  • Uses nv-versions.json format for version management (removed legacy versions.json)

Documentation Standards

  • Updated contribute.md to follow Apache 2.0 license format consistent with cuda-pathfinder licensing
  • Set copyright year to start from 2025
  • Removed unnecessary static assets and configuration sections
  • Cleaned up intersphinx mappings to include only essential references
  • Updated cuda-core and cuda-bindings README files to consistently reference nv-versions.json instead of versions.json

The new documentation provides a professional, searchable interface that matches the existing CUDA Python documentation ecosystem while preserving all the detailed technical content from the original README.

New Documentation URLs:

Doc Preview URLs now include:

  • Main CUDA Python docs
  • cuda-core documentation
  • cuda-bindings documentation
  • cuda-pathfinder documentation (newly added)

Fixes #760.


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copy link
Contributor

copy-pr-bot bot commented Aug 21, 2025

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@Copilot Copilot AI changed the title [WIP] Add Sphinx docs for cuda.pathfinder Add Sphinx documentation for cuda.pathfinder Aug 21, 2025
@Copilot Copilot AI requested a review from leofang August 21, 2025 18:45
Copilot finished work on behalf of leofang August 21, 2025 18:45
Copy link
Member

@leofang leofang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@github-project-automation github-project-automation bot moved this from Todo to In Progress in CCCL Aug 21, 2025
Copy link
Contributor Author

Copilot AI commented Aug 21, 2025

@copilot

I've addressed all the review feedback in commit 12c065f:

  • Fixed all references from cuda-bindings to cuda-pathfinder and versions.json to nv-versions.json
  • Removed unnecessary static image files and support.rst
  • Populated API.rst with public APIs from pathfinder README
  • Fixed copyright year and cleaned up conf.py
  • Updated contribute.md to follow cuda-core format with Apache 2.0 license
  • Removed old versions.json file

The documentation should now be consistent with the cuda-core format and ready for review.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • docs.python.org
    • Triggering command: /usr/bin/python3 /home/REDACTED/.local/bin/sphinx-build -b html source build/html/1.1.0 -j 1 -d build/.doctrees (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

@Copilot Copilot AI requested a review from leofang August 21, 2025 19:02
Copilot finished work on behalf of leofang August 21, 2025 19:02
@leofang
Copy link
Member

leofang commented Aug 21, 2025

/ok to test 12c065f

This comment has been minimized.

@leofang
Copy link
Member

leofang commented Aug 21, 2025

@copilot please update the doc preview CI to also show pathfinder docs

Copy link
Contributor Author

Copilot AI commented Aug 21, 2025

@copilot please update the doc preview CI to also show pathfinder docs

Updated the doc preview CI to include pathfinder documentation link in commit e86e775. The doc preview comments will now show links for cuda-pathfinder alongside cuda-core and cuda-bindings.

Copilot finished work on behalf of leofang August 21, 2025 20:11
@leofang
Copy link
Member

leofang commented Aug 21, 2025

pre-commit.ci autofix

@rwgk
Copy link
Collaborator

rwgk commented Aug 25, 2025

/ok to test

Copy link
Contributor

copy-pr-bot bot commented Aug 25, 2025

/ok to test

@rwgk, there was an error processing your request: E1

See the following link for more information: https://docs.gha-runners.nvidia.com/cpr/e/1/

@rwgk
Copy link
Collaborator

rwgk commented Aug 25, 2025

/ok to test d5c5b79

@rwgk rwgk force-pushed the copilot/fix-760 branch from 1f34f99 to 27692dd Compare August 26, 2025 22:43
@rwgk rwgk force-pushed the copilot/fix-760 branch from 27692dd to a97918e Compare August 26, 2025 22:44
@rwgk
Copy link
Collaborator

rwgk commented Aug 26, 2025

/ok to test

Copy link
Contributor

copy-pr-bot bot commented Aug 26, 2025

/ok to test

@rwgk, there was an error processing your request: E1

See the following link for more information: https://docs.gha-runners.nvidia.com/cpr/e/1/

@rwgk
Copy link
Collaborator

rwgk commented Aug 26, 2025

/ok to test a97918e

Copy link
Member

@leofang leofang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great, thanks Ralf!

@leofang
Copy link
Member

leofang commented Aug 27, 2025

Looks like I cannot merge my own PR.

@leofang leofang added this to the pathfinder-nvmath-support milestone Aug 27, 2025
@github-project-automation github-project-automation bot moved this from In Progress to In Review in CCCL Aug 27, 2025
@rwgk rwgk merged commit 135af40 into main Aug 27, 2025
48 checks passed
@rwgk rwgk deleted the copilot/fix-760 branch August 27, 2025 06:36
@github-project-automation github-project-automation bot moved this from In Review to Done in CCCL Aug 27, 2025
Copy link

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.pathfinder Everything related to the cuda.pathfinder module documentation Improvements or additions to documentation P0 High priority - Must do!

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

Add Sphinx docs for cuda.pathfinder

3 participants