Skip to content

Update docs to use NVIDIA Sphinx theme #151

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

Open
bdice wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Update docs to use NVIDIA Sphinx theme #151

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b37d355
Update docs to use NVIDIA Sphinx theme
bdice Jul 2, 2026
6f8f472
Update docs branding and copyright
bdice Jul 2, 2026
16ff2ff
Update documentation landing page
bdice Jul 2, 2026
6b2e5cc
Align documentation branding
bdice Jul 2, 2026
5f01236
Merge remote-tracking branch 'origin/main' into nvidia-sphinx-theme
hcho3 Jul 2, 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
3 changes: 2 additions & 1 deletion 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 @@ -29,7 +29,6 @@ dependencies:
- packaging
- pandas
- pre-commit
- pydata-sphinx-theme
- pylibraft==26.8.*,>=0.0.0a0
- pytest
- pytest-cov
Expand All @@ -45,4 +44,6 @@ dependencies:
- sphinx-markdown-tables
- sysroot_linux-aarch64==2.28
- treelite>=4.7.0,<5.0
- pip:
- nvidia-sphinx-theme
name: all_cuda-129_arch-aarch64
3 changes: 2 additions & 1 deletion 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 @@ -29,7 +29,6 @@ dependencies:
- packaging
- pandas
- pre-commit
- pydata-sphinx-theme
- pylibraft==26.8.*,>=0.0.0a0
- pytest
- pytest-cov
Expand All @@ -45,4 +44,6 @@ dependencies:
- sphinx-markdown-tables
- sysroot_linux-64==2.28
- treelite>=4.7.0,<5.0
- pip:
- nvidia-sphinx-theme
name: all_cuda-129_arch-x86_64
3 changes: 2 additions & 1 deletion 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 @@ -29,7 +29,6 @@ dependencies:
- packaging
- pandas
- pre-commit
- pydata-sphinx-theme
- pylibraft==26.8.*,>=0.0.0a0
- pytest
- pytest-cov
Expand All @@ -45,4 +44,6 @@ dependencies:
- sphinx-markdown-tables
- sysroot_linux-aarch64==2.28
- treelite>=4.7.0,<5.0
- pip:
- nvidia-sphinx-theme
name: all_cuda-133_arch-aarch64
3 changes: 2 additions & 1 deletion 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 @@ -29,7 +29,6 @@ dependencies:
- packaging
- pandas
- pre-commit
- pydata-sphinx-theme
- pylibraft==26.8.*,>=0.0.0a0
- pytest
- pytest-cov
Expand All @@ -45,4 +44,6 @@ dependencies:
- sphinx-markdown-tables
- sysroot_linux-64==2.28
- treelite>=4.7.0,<5.0
- pip:
- nvidia-sphinx-theme
name: all_cuda-133_arch-x86_64
4 changes: 0 additions & 4 deletions cpp/doxygen/header.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +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>
Expand Down
3 changes: 2 additions & 1 deletion dependencies.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -347,7 +347,8 @@ dependencies:
- graphviz
- numpydoc
- &packaging packaging
- pydata-sphinx-theme
- pip:
- nvidia-sphinx-theme
- sphinx
- sphinx-copybutton
- sphinx-markdown-tables
Expand Down
21 changes: 5 additions & 16 deletions docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@
master_doc = "index"

# General information about the project.
project = "nvforest"
project = "NVIDIA nvForest"
copyright = f"2026-{datetime.datetime.today().year}, NVIDIA Corporation"
author = "NVIDIA Corporation"

Expand Down Expand Up @@ -111,8 +111,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 All @@ -123,12 +122,6 @@
"icon": "fa-brands fa-github",
"type": "fontawesome",
},
{
"name": "X",
"url": "https://x.com/rapidsai",
"icon": "fa-brands fa-x-twitter",
"type": "fontawesome",
},
],
"show_toc_level": 1,
"navbar_align": "right",
Expand Down Expand Up @@ -172,7 +165,7 @@
(
master_doc,
"nvforest.tex",
"nvforest Documentation",
f"{project} Documentation",
"NVIDIA Corporation",
"manual",
),
Expand All @@ -182,7 +175,7 @@

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [(master_doc, "nvforest", "nvforest Documentation", [author], 1)]
man_pages = [(master_doc, "nvforest", f"{project} Documentation", [author], 1)]

# -- Options for Texinfo output -------------------------------------------

Expand All @@ -193,7 +186,7 @@
(
master_doc,
"nvforest",
"nvforest Documentation",
f"{project} Documentation",
author,
"nvforest",
"One line description of project.",
Expand All @@ -216,10 +209,6 @@

def setup(app):
app.add_css_file("custom.css")
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"
)


# The following is used by sphinx.ext.linkcode to provide links to github
Expand Down
6 changes: 3 additions & 3 deletions docs/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Welcome to nvForest's documentation!
====================================
NVIDIA nvForest Documentation
=============================

nvForest is a highly-optimized and lightweight library that enables fast inference for decision tree models on NVIDIA GPUs and CPUs.
NVIDIA nvForest is a highly-optimized and lightweight library that enables fast inference for decision tree models on NVIDIA GPUs and CPUs.
It supports many kinds of decision tree models, including XGBoost, LightGBM, scikit-learn, and cuML random forests.

* :doc:`getting_started`
Expand Down
Loading