Skip to content

Update RMM docs to use NVIDIA theme #2443

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rapids-bot merged 7 commits into from
Jun 26, 2026
Merged

Update RMM docs to use NVIDIA theme #2443

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
3ca7e0b
Use NVIDIA docs theme
bdice Jun 7, 2026
b5bfe94
Remove graphviz support
bdice Jun 7, 2026
a57cb20
Update header
bdice Jun 7, 2026
df0d9b1
Remove RAPIDS JS/CSS assets, those are also added in postprocessing.
bdice Jun 9, 2026
45856ef
Improve RMM docs navigation and memory resource overview
bdice Jun 9, 2026
9963ba6
Simplify docs
bdice Jun 26, 2026
a1712f3
Merge remote-tracking branch 'upstream/main' into nvidia-docs-theme
bdice Jun 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions conda/environments/all_cuda-129_arch-aarch64.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ dependencies:
- doxygen=1.9.1
- gcc_linux-aarch64=14.*
- gcovr>=5.0
- graphviz
- identify>=2.5.20
- ipython
- make
Expand All @@ -31,7 +30,6 @@ dependencies:
- numpydoc
- packaging
- pre-commit
- pydata-sphinx-theme>=0.15.4
- pytest
- pytest-cov
- python>=3.11
Expand All @@ -43,4 +41,6 @@ dependencies:
- sphinx-markdown-tables
- sphinxcontrib-jquery
- sysroot_linux-aarch64==2.28
- pip:
- nvidia-sphinx-theme
name: all_cuda-129_arch-aarch64
4 changes: 2 additions & 2 deletions conda/environments/all_cuda-129_arch-x86_64.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ dependencies:
- doxygen=1.9.1
- gcc_linux-64=14.*
- gcovr>=5.0
- graphviz
- identify>=2.5.20
- ipython
- make
Expand All @@ -31,7 +30,6 @@ dependencies:
- numpydoc
- packaging
- pre-commit
- pydata-sphinx-theme>=0.15.4
- pytest
- pytest-cov
- python>=3.11
Expand All @@ -43,4 +41,6 @@ dependencies:
- sphinx-markdown-tables
- sphinxcontrib-jquery
- sysroot_linux-64==2.28
- pip:
- nvidia-sphinx-theme
name: all_cuda-129_arch-x86_64
4 changes: 2 additions & 2 deletions conda/environments/all_cuda-133_arch-aarch64.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ dependencies:
- doxygen=1.9.1
- gcc_linux-aarch64=14.*
- gcovr>=5.0
- graphviz
- identify>=2.5.20
- ipython
- make
Expand All @@ -31,7 +30,6 @@ dependencies:
- numpydoc
- packaging
- pre-commit
- pydata-sphinx-theme>=0.15.4
- pytest
- pytest-cov
- python>=3.11
Expand All @@ -43,4 +41,6 @@ dependencies:
- sphinx-markdown-tables
- sphinxcontrib-jquery
- sysroot_linux-aarch64==2.28
- pip:
- nvidia-sphinx-theme
name: all_cuda-133_arch-aarch64
4 changes: 2 additions & 2 deletions conda/environments/all_cuda-133_arch-x86_64.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ dependencies:
- doxygen=1.9.1
- gcc_linux-64=14.*
- gcovr>=5.0
- graphviz
- identify>=2.5.20
- ipython
- make
Expand All @@ -31,7 +30,6 @@ dependencies:
- numpydoc
- packaging
- pre-commit
- pydata-sphinx-theme>=0.15.4
- pytest
- pytest-cov
- python>=3.11
Expand All @@ -43,4 +41,6 @@ dependencies:
- sphinx-markdown-tables
- sphinxcontrib-jquery
- sysroot_linux-64==2.28
- pip:
- nvidia-sphinx-theme
name: all_cuda-133_arch-x86_64
2 changes: 1 addition & 1 deletion cpp/doxygen/Doxyfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2285,7 +2285,7 @@ HIDE_UNDOC_RELATIONS = YES
# set to NO
# The default value is: NO.

HAVE_DOT = YES
HAVE_DOT = NO

# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
# to run in parallel. When set to 0 doxygen will base this on the number of
Expand Down
5 changes: 0 additions & 5 deletions cpp/doxygen/header.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,6 @@
<link href="$relpath^$stylesheet" rel="stylesheet" type="text/css" />
$extrastylesheet

<!-- RAPIDS CUSTOM JS & CSS: START, Please add these two lines back after every version upgrade -->
<script defer src="https://docs.rapids.ai/assets/js/custom.js"></script>
<link rel="stylesheet" href="https://docs.rapids.ai/assets/css/custom.css">
<!-- RAPIDS CUSTOM JS & CSS: END -->

</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
Expand Down
4 changes: 2 additions & 2 deletions dependencies.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -344,19 +344,19 @@ dependencies:
packages:
- breathe>=4.35.0
- *doxygen
- graphviz
- ipython
- make
- myst-parser
- nbsphinx
- &numba numba>=0.60.0,<0.65.0
- &numba_cuda numba-cuda>=0.22.1
- numpydoc
- pydata-sphinx-theme>=0.15.4
- sphinx
- sphinx-copybutton
- sphinx-markdown-tables
- sphinxcontrib-jquery
- pip:
- nvidia-sphinx-theme
py_version:
specific:
- output_types: conda
Expand Down
11 changes: 3 additions & 8 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# SPDX-FileCopyrightText: Copyright (c) 2020-2025, NVIDIA CORPORATION.
# SPDX-FileCopyrightText: Copyright (c) 2020-2026, NVIDIA CORPORATION.
# SPDX-License-Identifier: Apache-2.0

# Configuration file for the Sphinx documentation builder.
Expand All @@ -22,7 +22,7 @@

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

project = "rmm"
project = "RMM"
copyright = f"2018-{datetime.datetime.today().year}, NVIDIA Corporation"
author = "NVIDIA Corporation"

Expand Down Expand Up @@ -117,8 +117,7 @@
# a list of builtin themes.
#

html_theme = "pydata_sphinx_theme"
html_logo = "_static/RAPIDS-logo-purple.png"
html_theme = "nvidia_sphinx_theme"

html_theme_options = {
"external_links": [],
Expand Down Expand Up @@ -322,8 +321,4 @@ def on_missing_reference(app, env, node, contnode):


def setup(app):
app.add_css_file("https://docs.rapids.ai/assets/css/custom.css")
app.add_js_file(
"https://docs.rapids.ai/assets/js/custom.js", loading_method="defer"
)
app.connect("missing-reference", on_missing_reference)
4 changes: 4 additions & 0 deletions docs/cpp/memory_resources/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Memory Resources

RMM memory resources are allocator objects that control where and how memory is allocated.

Memory resources implement allocation and deallocation for a kind of memory, for example CUDA device memory, managed memory, or pinned host memory. Resource adaptors wrap another memory resource and change its behavior, such as adding logging, tracking, limits, alignment, or prefetching, while delegating the actual allocation to the wrapped upstream resource.

```{toctree}
:maxdepth: 1

Expand Down
Loading