-
Notifications
You must be signed in to change notification settings - Fork 83
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #223 from vzhurba01/doc-build-test
Doc build test
- Loading branch information
Showing
542 changed files
with
176,703 additions
and
20,902 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| # Sphinx build info version 1 | ||
| # This file records the configuration used when building these files. When it is not found, a full rebuild will be done. | ||
| config: 2f9c4a1944b1a0d538f9f880d688e4c2 | ||
| tags: 645f666f9bcd5a90fca523b33c5a78b7 |
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| CUDA Python | ||
| =========== | ||
|
|
||
| CUDA Python is the home for accessing NVIDIA's CUDA platform from Python. It consists of | ||
| multiple components: | ||
|
|
||
| - `cuda.core`_: Pythonic access to CUDA runtime and other core functionalities | ||
| - `cuda.bindings`_: Low-level Python bindings to CUDA C APIs | ||
| - `cuda.cooperative`_: Pythonic exposure of CUB cooperative algorithms | ||
| - `cuda.parallel`_: Pythonic exposure of Thrust parallel algorithms | ||
|
|
||
| For access to NVIDIA Math Libraries, please refer to `nvmath-python`_. | ||
|
|
||
| .. _nvmath-python: https://docs.nvidia.com/cuda/nvmath-python/latest | ||
|
|
||
| CUDA Python is currently undergoing an overhaul to improve existing and bring up new components. | ||
| All of the previously available functionalities from the ``cuda-python`` package will continue to | ||
| be available, please refer to the `cuda.bindings`_ documentation for installation guide and further detail. | ||
|
|
||
| .. | ||
| The urls above can be auto-inserted by Sphinx (see rst_epilog in conf.py), but | ||
| not for the urls below, which must be hard-coded due to Sphinx limitation... | ||
| .. toctree:: | ||
| :maxdepth: 2 | ||
| :caption: Contents: | ||
|
|
||
| release.md | ||
| cuda.core <https://nvidia.github.io/cuda-python/cuda-core/latest> | ||
| cuda.bindings <https://nvidia.github.io/cuda-python/cuda-bindings/latest> | ||
| cuda.cooperative <https://nvidia.github.io/cccl/cuda_cooperative> | ||
| cuda.parallel <https://nvidia.github.io/cccl/cuda_parallel> | ||
| conduct.md | ||
| contribute.md |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| # Release Notes | ||
|
|
||
| ```{toctree} | ||
| --- | ||
| maxdepth: 3 | ||
| --- | ||
|
|
||
| 12.6.1 <release/12.6.1-notes> | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| # CUDA Python Release notes | ||
|
|
||
| Released on Oct 7, 2024 | ||
|
|
||
| ## Included components | ||
|
|
||
| - [`cuda.bindings` 12.6.1](https://nvidia.github.io/cuda-python/cuda-bindings/12.6.1/release/12.6.1-notes.html) | ||
|
|
||
|
|
||
| ## Hightlights | ||
| - Internal layout refactoring to prepare for the `cuda-python` metapackage ([Issue #90](https://github.com/NVIDIA/cuda-python/issues/90), | ||
| [Issue #75](https://github.com/NVIDIA/cuda-python/issues/75)) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,149 @@ | ||
| /* | ||
| * Base JavaScript utilities for all Sphinx HTML documentation. | ||
| */ | ||
| "use strict"; | ||
|
|
||
| const BLACKLISTED_KEY_CONTROL_ELEMENTS = new Set([ | ||
| "TEXTAREA", | ||
| "INPUT", | ||
| "SELECT", | ||
| "BUTTON", | ||
| ]); | ||
|
|
||
| const _ready = (callback) => { | ||
| if (document.readyState !== "loading") { | ||
| callback(); | ||
| } else { | ||
| document.addEventListener("DOMContentLoaded", callback); | ||
| } | ||
| }; | ||
|
|
||
| /** | ||
| * Small JavaScript module for the documentation. | ||
| */ | ||
| const Documentation = { | ||
| init: () => { | ||
| Documentation.initDomainIndexTable(); | ||
| Documentation.initOnKeyListeners(); | ||
| }, | ||
|
|
||
| /** | ||
| * i18n support | ||
| */ | ||
| TRANSLATIONS: {}, | ||
| PLURAL_EXPR: (n) => (n === 1 ? 0 : 1), | ||
| LOCALE: "unknown", | ||
|
|
||
| // gettext and ngettext don't access this so that the functions | ||
| // can safely bound to a different name (_ = Documentation.gettext) | ||
| gettext: (string) => { | ||
| const translated = Documentation.TRANSLATIONS[string]; | ||
| switch (typeof translated) { | ||
| case "undefined": | ||
| return string; // no translation | ||
| case "string": | ||
| return translated; // translation exists | ||
| default: | ||
| return translated[0]; // (singular, plural) translation tuple exists | ||
| } | ||
| }, | ||
|
|
||
| ngettext: (singular, plural, n) => { | ||
| const translated = Documentation.TRANSLATIONS[singular]; | ||
| if (typeof translated !== "undefined") | ||
| return translated[Documentation.PLURAL_EXPR(n)]; | ||
| return n === 1 ? singular : plural; | ||
| }, | ||
|
|
||
| addTranslations: (catalog) => { | ||
| Object.assign(Documentation.TRANSLATIONS, catalog.messages); | ||
| Documentation.PLURAL_EXPR = new Function( | ||
| "n", | ||
| `return (${catalog.plural_expr})` | ||
| ); | ||
| Documentation.LOCALE = catalog.locale; | ||
| }, | ||
|
|
||
| /** | ||
| * helper function to focus on search bar | ||
| */ | ||
| focusSearchBar: () => { | ||
| document.querySelectorAll("input[name=q]")[0]?.focus(); | ||
| }, | ||
|
|
||
| /** | ||
| * Initialise the domain index toggle buttons | ||
| */ | ||
| initDomainIndexTable: () => { | ||
| const toggler = (el) => { | ||
| const idNumber = el.id.substr(7); | ||
| const toggledRows = document.querySelectorAll(`tr.cg-${idNumber}`); | ||
| if (el.src.substr(-9) === "minus.png") { | ||
| el.src = `${el.src.substr(0, el.src.length - 9)}plus.png`; | ||
| toggledRows.forEach((el) => (el.style.display = "none")); | ||
| } else { | ||
| el.src = `${el.src.substr(0, el.src.length - 8)}minus.png`; | ||
| toggledRows.forEach((el) => (el.style.display = "")); | ||
| } | ||
| }; | ||
|
|
||
| const togglerElements = document.querySelectorAll("img.toggler"); | ||
| togglerElements.forEach((el) => | ||
| el.addEventListener("click", (event) => toggler(event.currentTarget)) | ||
| ); | ||
| togglerElements.forEach((el) => (el.style.display = "")); | ||
| if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler); | ||
| }, | ||
|
|
||
| initOnKeyListeners: () => { | ||
| // only install a listener if it is really needed | ||
| if ( | ||
| !DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS && | ||
| !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS | ||
| ) | ||
| return; | ||
|
|
||
| document.addEventListener("keydown", (event) => { | ||
| // bail for input elements | ||
| if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; | ||
| // bail with special keys | ||
| if (event.altKey || event.ctrlKey || event.metaKey) return; | ||
|
|
||
| if (!event.shiftKey) { | ||
| switch (event.key) { | ||
| case "ArrowLeft": | ||
| if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; | ||
|
|
||
| const prevLink = document.querySelector('link[rel="prev"]'); | ||
| if (prevLink && prevLink.href) { | ||
| window.location.href = prevLink.href; | ||
| event.preventDefault(); | ||
| } | ||
| break; | ||
| case "ArrowRight": | ||
| if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; | ||
|
|
||
| const nextLink = document.querySelector('link[rel="next"]'); | ||
| if (nextLink && nextLink.href) { | ||
| window.location.href = nextLink.href; | ||
| event.preventDefault(); | ||
| } | ||
| break; | ||
| } | ||
| } | ||
|
|
||
| // some keyboard layouts may need Shift to get / | ||
| switch (event.key) { | ||
| case "/": | ||
| if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break; | ||
| Documentation.focusSearchBar(); | ||
| event.preventDefault(); | ||
| } | ||
| }); | ||
| }, | ||
| }; | ||
|
|
||
| // quick alias for translations | ||
| const _ = Documentation.gettext; | ||
|
|
||
| _ready(Documentation.init); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes
Oops, something went wrong.