FilesExpand file tree

 main

/

conf.py

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

102 lines (86 loc) · 3.91 KB

 main

/

conf.py

Copy path

Top

File metadata and controls

• Code
• Blame

102 lines (86 loc) · 3.91 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

# Copyright (c) 2021-2025, NVIDIA CORPORATION & AFFILIATES. ALL RIGHTS RESERVED.

# SPDX-License-Identifier: LicenseRef-NVIDIA-SOFTWARE-LICENSE

# Configuration file for the Sphinx documentation builder.

#

# This file only contains a selection of the most common options. For a full

# list see the documentation:

# https://www.sphinx-doc.org/en/master/usage/configuration.html

# -- Path setup --------------------------------------------------------------

# If extensions (or modules to document with autodoc) are in another directory,

# add these directories to sys.path here. If the directory is relative to the

# documentation root, use os.path.abspath to make it absolute, like shown here.

import os

# import sys

# sys.path.insert(0, os.path.abspath('.'))

# -- Project information -----------------------------------------------------

project = "CUDA Python"

copyright = "2021-2024, NVIDIA"

author = "NVIDIA"

# The full version, including alpha/beta/rc tags

release = os.environ["SPHINX_CUDA_PYTHON_VER"]

# -- General configuration ---------------------------------------------------

# Add any Sphinx extension module names here, as strings. They can be

# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom

# ones.

extensions = [

"sphinx.ext.autodoc",

"sphinx.ext.napoleon",

"myst_nb",

"enum_tools.autoenum",

]

# Add any paths that contain templates here, relative to this directory.

templates_path = ["_templates"]

# List of patterns, relative to source directory, that match files and

# directories to ignore when looking for source files.

# This pattern also affects html_static_path and html_extra_path.

exclude_patterns = []

# -- Options for HTML output -------------------------------------------------

# The theme to use for HTML and HTML Help pages. See the documentation for

# a list of builtin themes.

html_baseurl = "docs"

html_theme = "furo"

# html_theme = 'pydata_sphinx_theme'

html_theme_options = {

"light_logo": "logo-light-mode.png",

"dark_logo": "logo-dark-mode.png",

# For pydata_sphinx_theme:

# "logo": {

# "image_light": "_static/logo-light-mode.png",

# "image_dark": "_static/logo-dark-mode.png",

# },

# "switcher": {

# "json_url": "https://nvidia.github.io/cuda-python/cuda-core/versions.json",

# "version_match": release,

# },

## Add light/dark mode and documentation version switcher

# "navbar_end": [

# "search-button",

# "theme-switcher",

# "version-switcher",

# "navbar-icon-links",

# ],

}

if os.environ.get("CI"):

if int(os.environ.get("BUILD_PREVIEW", 0)):

PR_NUMBER = f"{os.environ['PR_NUMBER']}"

PR_TEXT = f'<a href="https://github.com/NVIDIA/cuda-python/pull/{PR_NUMBER}">PR {PR_NUMBER}</a>'

html_theme_options["announcement"] = f"<em>Warning</em>: This documentation is only a preview for {PR_TEXT}!"

elif int(os.environ.get("BUILD_LATEST", 0)):

html_theme_options["announcement"] = (

"<em>Warning</em>: This documentation is built from the development branch!"

)

# Add any paths that contain custom static files (such as style sheets) here,

# relative to this directory. They are copied after the builtin static files,

# so a file named "default.css" will overwrite the builtin "default.css".

html_static_path = ["_static"]

# Allow overwriting CUDA Python's domain name for local development. See:

# - https://stackoverflow.com/a/61694897/2344149

# - https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-rst_epilog

CUDA_PYTHON_DOMAIN = os.environ.get("CUDA_PYTHON_DOMAIN", "https://nvidia.github.io/cuda-python")

rst_epilog = f"""

.. _cuda.core: {CUDA_PYTHON_DOMAIN}/cuda-core/latest

.. _cuda.bindings: {CUDA_PYTHON_DOMAIN}/cuda-bindings/latest

.. _cuda.cooperative: https://nvidia.github.io/cccl/cuda_cooperative/

.. _cuda.parallel: https://nvidia.github.io/cccl/cuda_parallel/

.. _numba.cuda: https://nvidia.github.io/numba-cuda/

"""