Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,6 @@ dependencies:
- polars>=1.35,<1.42
- pre-commit
- pyarrow>=19.0.0,<24
- pydata-sphinx-theme>=0.15.4
- pytables
- pytest-benchmark
- pytest-cases>=3.8.2
Expand Down Expand Up @@ -118,4 +117,6 @@ dependencies:
- xlsxwriter
- zlib>=1.2.13
- zstandard
- 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
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,6 @@ dependencies:
- polars>=1.35,<1.42
- pre-commit
- pyarrow>=19.0.0,<24
- pydata-sphinx-theme>=0.15.4
- pytables
- pytest-benchmark
- pytest-cases>=3.8.2
Expand Down Expand Up @@ -118,4 +117,6 @@ dependencies:
- xlsxwriter
- zlib>=1.2.13
- zstandard
- 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
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,6 @@ dependencies:
- polars>=1.35,<1.42
- pre-commit
- pyarrow>=19.0.0,<24
- pydata-sphinx-theme>=0.15.4
- pytables
- pytest-benchmark
- pytest-cases>=3.8.2
Expand Down Expand Up @@ -118,4 +117,6 @@ dependencies:
- xlsxwriter
- zlib>=1.2.13
- zstandard
- 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
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,6 @@ dependencies:
- polars>=1.35,<1.42
- pre-commit
- pyarrow>=19.0.0,<24
- pydata-sphinx-theme>=0.15.4
- pytables
- pytest-benchmark
- pytest-cases>=3.8.2
Expand Down Expand Up @@ -118,4 +117,6 @@ dependencies:
- xlsxwriter
- zlib>=1.2.13
- zstandard
- pip:
- nvidia-sphinx-theme
name: all_cuda-133_arch-x86_64
4 changes: 0 additions & 4 deletions cpp/doxygen/header.html
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>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
Expand Down
10 changes: 2 additions & 8 deletions dependencies.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -864,21 +864,15 @@ dependencies:
- nbsphinx
- numpydoc
- pandoc
# Minimum version for safe parallel writing again.
# https://github.com/pydata/pydata-sphinx-theme/pull/1859
# https://github.com/pydata/pydata-sphinx-theme/releases/tag/v0.15.4
- pydata-sphinx-theme>=0.15.4
- scipy
# Needed for safe parallel writes as with the pydata-sphinx-theme pin above
# https://github.com/sphinx-doc/sphinx/issues/12409
# https://github.com/sphinx-doc/sphinx/pull/12888
# https://github.com/sphinx-doc/sphinx/releases/tag/v8.1.0
- sphinx>=8.1.0
- sphinx-autobuild
- sphinx-copybutton
- sphinx-markdown-tables
- sphinx-remove-toctrees
- sphinxcontrib-websupport
- pip:
- nvidia-sphinx-theme
notebooks:
common:
- output_types: [conda, requirements]
Expand Down
44 changes: 44 additions & 0 deletions docs/cudf/source/_templates/sidebar-nav-bs.html
Comment thread
bdice marked this conversation as resolved.
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
{#
Override PyData Sphinx Theme's sidebar-nav-bs.html component.

NVIDIA Sphinx Theme inherits PyData's default primary sidebar configuration,
which includes this component by template name. Placing a file with the same
name in the project's _templates directory makes Sphinx use this version.

PyData's generate_toctree_html("sidebar", startdepth=1, ...) returns the
normal sidebar tree rooted at the currently active top-level toctree item.
That is correct for nested pages such as cudf/api_docs/index, where the
sidebar should still show the active API reference node and its foldable
children. For top-level section landing pages such as cudf_pandas/index,
that output duplicates the primary navbar item in the sidebar, so we render
only the active section's child <ul> on those landing pages.
#}
{% set show_nav_level = meta['html_theme.show_nav_level'] if (meta is defined and meta is not none and 'html_theme.show_nav_level' in meta) else theme_show_nav_level %}
{% set special_page = pagename == root_doc or pagename in ["genindex", "py-modindex", "search"] %}
{% if not special_page %}
{% set nav_tree = generate_toctree_html(
"sidebar",
startdepth=1,
show_nav_level=show_nav_level | int,
maxdepth=theme_navigation_depth | int,
collapse=theme_collapse_navigation | tobool,
includehidden=theme_sidebar_includehidden | tobool,
titles_only=True,
) %}
{% set pagename_parts = pagename.split("/") %}
{% set top_section_page = pagename_parts | length == 2 and pagename_parts[-1] == "index" %}
{% if top_section_page %}
{% set active_section = nav_tree.select_one("li.toctree-l1.current") %}
{% set active_details = active_section.find("details", recursive=False) if active_section else none %}
{% set section_nav = active_details.find("ul", recursive=False) if active_details else nav_tree %}
{% else %}
{% set section_nav = nav_tree %}
{% endif %}
<nav class="bd-docs-nav bd-links"
aria-label="{{ _('Section Navigation') }}">
<p class="bd-links__title" role="heading" aria-level="1">{{ _("Section Navigation") }}</p>
<div class="bd-toc-item navbar-nav">
{{ section_nav }}
</div>
</nav>
{% endif %}
11 changes: 3 additions & 8 deletions docs/cudf/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@ def clean_all_xml_files(path):
master_doc = "index"

# General information about the project.
project = "cudf"
project = "cuDF"
copyright = f"2018-{datetime.datetime.today().year}, NVIDIA Corporation"
author = "NVIDIA Corporation"

Expand Down Expand Up @@ -226,12 +226,12 @@ def clean_all_xml_files(path):

html_theme_options = {
"external_links": [],
# https://github.com/pydata/pydata-sphinx-theme/issues/1220
"icon_links": [],
"github_url": "https://github.com/rapidsai/cudf",
"twitter_url": "https://twitter.com/rapidsai",
"show_toc_level": 1,
"navbar_align": "content",
"navbar_center": "navbar-nav, version-switcher, navbar-external-links",
"navigation_with_keys": True,
}
include_pandas_compat = True
Expand All @@ -241,8 +241,7 @@ def clean_all_xml_files(path):
# a list of builtin themes.
#

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


# Theme options are theme-specific and customize the look and feel of a theme
Expand Down Expand Up @@ -780,10 +779,6 @@ def add_content(self, more_content) -> None:


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("doctree-read", resolve_aliases)
app.connect("missing-reference", on_missing_reference)
app.setup_extension("sphinx.ext.autodoc")
Expand Down
2 changes: 1 addition & 1 deletion docs/cudf/source/cudf/developer_guide/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ Section name
```

Each listed will automatically have its docstring rendered into a separate page.
This layout comes from [PyData Sphinx Theme](https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html).
This layout comes from [NVIDIA Sphinx Theme](https://pypi.org/project/nvidia-sphinx-theme/).

````{note}
Autosummary generates stub pages that look like this (using `cudf.concat` as an example):
Expand Down
1 change: 1 addition & 0 deletions docs/dask_cudf/source/_templates/sidebar-nav-bs.html
Comment thread
bdice marked this conversation as resolved.
15 changes: 4 additions & 11 deletions docs/dask_cudf/source/conf.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# SPDX-FileCopyrightText: Copyright (c) 2018-2026, NVIDIA CORPORATION.
# SPDX-FileCopyrightText: Copyright (c) 2018-2026, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
# SPDX-License-Identifier: Apache-2.0

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

DASK_CUDF_VERSION = Version(dask_cudf.__version__)

project = "dask-cudf"
project = "dask-cuDF"
copyright = f"2018-{datetime.datetime.today().year}, NVIDIA Corporation"
author = "NVIDIA Corporation"
version = f"{DASK_CUDF_VERSION.major:02}.{DASK_CUDF_VERSION.minor:02}"
Expand Down Expand Up @@ -50,8 +50,7 @@
# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

html_theme = "pydata_sphinx_theme"
html_logo = "_static/RAPIDS-logo-purple.png"
html_theme = "nvidia_sphinx_theme"
htmlhelp_basename = "dask-cudfdoc"
html_use_modindex = True

Expand All @@ -65,6 +64,7 @@
"twitter_url": "https://twitter.com/rapidsai",
"show_toc_level": 1,
"navbar_align": "right",
"navbar_center": "navbar-nav, version-switcher, navbar-external-links",
"navigation_with_keys": True,
}
include_pandas_compat = True
Expand All @@ -86,10 +86,3 @@
numpydoc_attributes_as_param_list = False

nitpicky = True


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"
)
Loading