Convert all markdown files in docs/source/ directories to reST (#897)

* Initial plan

* Phase 1: Use git mv to rename 38 markdown files to .rst preserving git history

Co-authored-by: leofang <5534781+leofang@users.noreply.github.com>

* Phase 2: Convert markdown syntax to ReST syntax in all 38 files

Co-authored-by: leofang <5534781+leofang@users.noreply.github.com>

* Phase 3: Update toctree references from .md to .rst

Co-authored-by: leofang <5534781+leofang@users.noreply.github.com>

* Phase 4: Add pre-commit hook to prevent new markdown files in docs/source/

Co-authored-by: leofang <5534781+leofang@users.noreply.github.com>

* Phase 5: Fix MyST syntax issues and validate conversion

Co-authored-by: leofang <5534781+leofang@users.noreply.github.com>

* Fix SPDX headers: Add missing copyright and license identifiers to converted .rst files

Co-authored-by: leofang <5534781+leofang@users.noreply.github.com>

* Fix reStructuredText issues: correct cross-refs, links, and code blocks

Co-authored-by: leofang <5534781+leofang@users.noreply.github.com>

* Fix code block consistency and Python comments in documentation

- Changed shell to console code-block in install.rst for consistency
- Converted explanatory text to Python comments in overview.rst code blocks
- Ensures all code blocks are copy-paste ready for execution

Co-authored-by: leofang <5534781+leofang@users.noreply.github.com>

* Fix reStructuredText syntax errors: correct toctree directive, broken hyperlinks, and code block formatting

Co-authored-by: leofang <5534781+leofang@users.noreply.github.com>

* Fix release.rst toctree titles and improve pre-commit hook message

Co-authored-by: leofang <5534781+leofang@users.noreply.github.com>

* Fix reStructuredText rendering issues: hyperlinks, code block introductions, and syntax errors

Co-authored-by: leofang <5534781+leofang@users.noreply.github.com>

* manual edit to fix rendering errors and prune outdated files

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: leofang <5534781+leofang@users.noreply.github.com>
Co-authored-by: Leo Fang <leof@nvidia.com>

Author: Copilot

.pre-commit-config.yaml

@@ -30,6 +30,14 @@ repos:
         language: python
         additional_dependencies:
           - https://files.pythonhosted.org/packages/cc/20/ff623b09d963f88bfde16306a54e12ee5ea43e9b597108672ff3a408aad6/pathspec-0.12.1-py3-none-any.whl
+      
+      - id: no-markdown-in-docs-source
+        name: Prevent markdown files in docs/source directories
+        entry: bash -c
+        args: ['if find . -path "*/docs/source/*.md" -not -path "./docs/README.md" | grep -q .; then echo "ERROR: Markdown files found in docs/source/ directories. Use reST (.rst) instead."; exit 1; fi']
+        language: system
+        pass_filenames: false
+        always_run: true
 
   - repo: https://github.com/PyCQA/bandit
     rev: 2d0b675b04c80ae42277e10500db06a0a37bae17  # frozen: 1.8.6

cuda_bindings/docs/source/_static/logo-dark-mode.png

@@ -1,10 +1,16 @@
-# Code of Conduct
+.. SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+.. SPDX-License-Identifier: LicenseRef-NVIDIA-SOFTWARE-LICENSE
 
-## Overview
+Code of Conduct
+===============
 
-Define the code of conduct followed and enforced for the `cuda.core` project.
+Overview
+--------
 
-## Our Pledge
+Define the code of conduct followed and enforced for the ``cuda.bindings`` project.
+
+Our Pledge
+----------
 
 In the interest of fostering an open and welcoming environment, we as
 contributors and maintainers pledge to making participation in our project and
@@ -13,7 +19,8 @@ size, disability, ethnicity, sex characteristics, gender identity and expression
 level of experience, education, socio-economic status, nationality, personal
 appearance, race, religion, or sexual identity and orientation.
 
-## Our Standards
+Our Standards
+-------------
 
 Examples of behavior that contributes to creating a positive environment
 include:
@@ -35,7 +42,8 @@ Examples of unacceptable behavior by participants include:
 * Other conduct which could reasonably be considered inappropriate in a
   professional setting
 
-## Our Responsibilities
+Our Responsibilities
+--------------------
 
 Project maintainers are responsible for clarifying the standards of acceptable
 behavior and are expected to take appropriate and fair corrective action in
@@ -47,7 +55,8 @@ that are not aligned to this Code of Conduct, or to ban temporarily or
 permanently any contributor for other behaviors that they deem inappropriate,
 threatening, offensive, or harmful.
 
-## Scope
+Scope
+-----
 
 This Code of Conduct applies both within project spaces and in public spaces
 when an individual is representing the project or its community. Examples of
@@ -56,11 +65,12 @@ address, posting via an official social media account, or acting as an appointed
 representative at an online or offline event. Representation of a project may be
 further defined and clarified by project maintainers.
 
-## Enforcement
+Enforcement
+-----------
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported by contacting the project team at
-[cuda-python-conduct@nvidia.com](mailto:cuda-python-conduct@nvidia.com) All
+`cuda-python-conduct@nvidia.com <mailto:cuda-python-conduct@nvidia.com>`_ All
 complaints will be reviewed and investigated and will result in a response that
 is deemed necessary and appropriate to the circumstances. The project team is
 obligated to maintain confidentiality with regard to the reporter of an
@@ -71,12 +81,11 @@ Project maintainers who do not follow or enforce the Code of Conduct in good
 faith may face temporary or permanent repercussions as determined by other
 members of the project's leadership.
 
-## Attribution
+Attribution
+-----------
 
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+This Code of Conduct is adapted from the `Contributor Covenant <https://www.contributor-covenant.org>`_, version 1.4,
 available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
 
-[homepage]: https://www.contributor-covenant.org
-
 For answers to common questions about this code of conduct, see
 https://www.contributor-covenant.org/faq

cuda_bindings/docs/source/_static/logo-light-mode.png

@@ -0,0 +1,15 @@
+.. SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+.. SPDX-License-Identifier: LicenseRef-NVIDIA-SOFTWARE-LICENSE
+
+Contributing
+============
+
+Thank you for your interest in contributing to ``cuda-bindings``! Based on the type of contribution, it will fall into two categories:
+
+1. You want to report a bug, feature request, or documentation issue
+    - File an `issue <https://github.com/NVIDIA/cuda-python/issues/new/choose>`_ describing what you encountered or what you want to see changed.
+    - The NVIDIA team will evaluate the issues and triage them, scheduling
+    them for a release. If you believe the issue needs priority attention
+    comment on the issue to notify the team.
+2. You want to implement a feature, improvement, or bug fix:
+    - At this time we do not accept code contributions.

cuda_core/docs/source/conduct.md cuda_bindings/docs/source/conduct.rstcuda_core/docs/source/conduct.md renamed to cuda_bindings/docs/source/conduct.rst

@@ -0,0 +1,21 @@
+.. SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+.. SPDX-License-Identifier: LicenseRef-NVIDIA-SOFTWARE-LICENSE
+
+Environment Variables
+=====================
+
+Runtime Environment Variables
+-----------------------------
+
+- ``CUDA_PYTHON_CUDA_PER_THREAD_DEFAULT_STREAM`` : When set to 1, the default stream is the per-thread default stream. When set to 0, the default stream is the legacy default stream. This defaults to 0, for the legacy default stream. See `Stream Synchronization Behavior <https://docs.nvidia.com/cuda/cuda-runtime-api/stream-sync-behavior.html>`_ for an explanation of the legacy and per-thread default streams.
+
+
+Build-Time Environment Variables
+--------------------------------
+
+- ``CUDA_HOME`` or ``CUDA_PATH``: Specifies the location of the CUDA Toolkit.
+
+- ``CUDA_PYTHON_PARSER_CACHING`` : bool, toggles the caching of parsed header files during the cuda-bindings build process. If caching is enabled (``CUDA_PYTHON_PARSER_CACHING`` is True), the cache path is set to ./cache_<library_name>, where <library_name> is derived from the cuda toolkit libraries used to build cuda-bindings.
+
+- ``CUDA_PYTHON_PARALLEL_LEVEL`` (previously ``PARALLEL_LEVEL``) : int, sets the number of threads used in the compilation of extension modules. Not setting it or setting it to 0 would disable parallel builds.
+

cuda_bindings/docs/source/contribute.md

@@ -9,15 +9,15 @@
    :caption: Contents:
 
    release
-   install.md
-   overview.md
-   motivation.md
-   environment_variables.md
+   install
+   overview
+   motivation
+   environment_variables
    api
    tips_and_tricks
    support
-   contribute.md
-   conduct.md
+   contribute
+   conduct
    license