+
+
+ {% endif %}
+
+
+
+
+{%- endblock %}
diff --git a/docs/source/_templates/merlin-ecosystem.html b/docs/source/_templates/merlin-ecosystem.html
new file mode 100644
index 000000000..a5d7eaee2
--- /dev/null
+++ b/docs/source/_templates/merlin-ecosystem.html
@@ -0,0 +1,13 @@
+
diff --git a/docs/source/_templates/versions.html b/docs/source/_templates/versions.html
index 31a125789..26e2a32fc 100644
--- a/docs/source/_templates/versions.html
+++ b/docs/source/_templates/versions.html
@@ -1,7 +1,7 @@
{%- if current_version %}
- Other Versions
+
v: {{ current_version.name }}
diff --git a/docs/source/conf.py b/docs/source/conf.py
index b84e45a9c..af514da90 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -26,7 +26,7 @@
# -- Project information -----------------------------------------------------
project = "Merlin Systems"
-copyright = "2022, NVIDIA" # pylint: disable=W0622
+copyright = "2024, NVIDIA" # pylint: disable=W0622
author = "NVIDIA"
@@ -37,8 +37,8 @@
# ones.
extensions = [
"myst_nb",
+ "sphinx_design",
"sphinx_multiversion",
- "sphinx_rtd_theme",
"sphinx.ext.autodoc",
"sphinx.ext.autosummary",
"sphinx.ext.coverage",
@@ -79,22 +79,39 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
-html_theme = "sphinx_rtd_theme"
+html_theme = "sphinx_book_theme"
+html_title = "Merlin Systems"
html_theme_options = {
- "navigation_depth": 2,
- "analytics_id": "G-NVJ1Y1YJHK",
+ "repository_url": "https://github.com/NVIDIA-Merlin/systems",
+ "use_repository_button": True,
+ "footer_content_items": ["copyright.html", "last-updated.html"],
+ "extra_footer": "",
+ "logo": {"text": "NVIDIA Merlin Systems", "alt_text": "NVIDIA Merlin Systems"},
}
+html_sidebars = {
+ "**": [
+ "navbar-logo.html",
+ "search-field.html",
+ "icon-links.html",
+ "sbt-sidebar-nav.html",
+ "merlin-ecosystem.html",
+ "versions.html",
+ ]
+}
+html_favicon = "_static/favicon.png"
+html_copy_source = True
+html_show_sourcelink = False
# 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"]
+html_css_files = ["css/custom.css", "css/versions.css"]
+html_js_files = ["js/rtd-version-switcher.js"]
+html_context = {"analytics_id": "G-NVJ1Y1YJHK"}
source_suffix = [".rst", ".md"]
-html_copy_source = False
-html_show_sourcelink = False
-
if os.path.exists(gitdir):
tag_refs = subprocess.check_output(["git", "tag", "-l", "v*"]).decode("utf-8").split()
tag_refs = [tag for tag in tag_refs if re.match(r"^v[0-9]+.[0-9]+.[0-9]+$", tag)]
@@ -128,5 +145,9 @@
autosummary_generate = True
-copydirs_additional_dirs = ["../../README.md", "../../examples/"]
+copydirs_additional_dirs = [
+ "../../LICENSE",
+ "../../README.md",
+ "../../examples/",
+]
copydirs_file_rename = {"README.md": "index.md"}
diff --git a/requirements/docs.txt b/requirements/docs.txt
index 9445871d9..f92247f33 100644
--- a/requirements/docs.txt
+++ b/requirements/docs.txt
@@ -4,17 +4,16 @@
tritonclient[all]
tensorflow<=2.9.0
-Sphinx==3.5.4
-sphinx_rtd_theme==1.0.0
+sphinx-book-theme~=1.1.2
sphinx-multiversion@git+https://github.com/mikemckiernan/sphinx-multiversion.git
sphinxcontrib-copydirs@git+https://github.com/mikemckiernan/sphinxcontrib-copydirs.git
-recommonmark==0.7.1
+recommonmark~=0.7.1
Jinja2<3.1
-natsort==8.0.1
-myst-nb==0.13.2
-linkify-it-py==1.0.3
-sphinx-external-toc==0.2.4
-attrs==21.4.0
+natsort~=8.4.0
+myst-nb~=1.1.0
+linkify-it-py~=2.0.3
+sphinx-external-toc~=1.0.1
+attrs~=23.2.0
# keep support for numpy builtin type aliases for previous tags
# numpy builtin aliases like np.str were removed in 1.24
From 302cd9b14d9186d59135ad1f6feb7fbaf30af0d7 Mon Sep 17 00:00:00 2001
From: Oliver Holworthy <1216955+oliverholworthy@users.noreply.github.com>
Date: Tue, 23 Apr 2024 11:21:15 +0100
Subject: [PATCH 2/6] Update sphinx book theme to 1.0.1
for python version 3.8 support
---
requirements/docs.txt | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/requirements/docs.txt b/requirements/docs.txt
index f92247f33..f014c6507 100644
--- a/requirements/docs.txt
+++ b/requirements/docs.txt
@@ -4,7 +4,7 @@
tritonclient[all]
tensorflow<=2.9.0
-sphinx-book-theme~=1.1.2
+sphinx-book-theme~=1.0.1
sphinx-multiversion@git+https://github.com/mikemckiernan/sphinx-multiversion.git
sphinxcontrib-copydirs@git+https://github.com/mikemckiernan/sphinxcontrib-copydirs.git
recommonmark~=0.7.1
From ba54ebd6bc1ee8d3f87d13165775380457a1feda Mon Sep 17 00:00:00 2001
From: Oliver Holworthy <1216955+oliverholworthy@users.noreply.github.com>
Date: Tue, 23 Apr 2024 11:21:55 +0100
Subject: [PATCH 3/6] Add env var for protocol buffers implementation
---
tox.ini | 2 ++
1 file changed, 2 insertions(+)
diff --git a/tox.ini b/tox.ini
index bba7db44c..0eb76e97d 100644
--- a/tox.ini
+++ b/tox.ini
@@ -47,6 +47,7 @@ sitepackages=true
; need to add some back.
setenv =
TF_GPU_ALLOCATOR=cuda_malloc_async
+ PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION=python
passenv =
OPAL_PREFIX
deps =
@@ -74,6 +75,7 @@ sitepackages=true
setenv =
TF_GPU_ALLOCATOR=cuda_malloc_async
LD_LIBRARY_PATH=/opt/tritonserver/backends/pytorch:{env:LD_LIBRARY_PATH}
+ PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION=python
passenv =
OPAL_PREFIX
deps =
From e2ac404114dd1097f3cbe152ca646b164621354a Mon Sep 17 00:00:00 2001
From: Oliver Holworthy <1216955+oliverholworthy@users.noreply.github.com>
Date: Tue, 23 Apr 2024 11:27:37 +0100
Subject: [PATCH 4/6] Update versions of myst-nb and sphinx-external-toc for
python 3.8
---
requirements/docs.txt | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/requirements/docs.txt b/requirements/docs.txt
index f014c6507..26d57f22c 100644
--- a/requirements/docs.txt
+++ b/requirements/docs.txt
@@ -10,9 +10,9 @@ sphinxcontrib-copydirs@git+https://github.com/mikemckiernan/sphinxcontrib-copydi
recommonmark~=0.7.1
Jinja2<3.1
natsort~=8.4.0
-myst-nb~=1.1.0
+myst-nb~=0.17.2
linkify-it-py~=2.0.3
-sphinx-external-toc~=1.0.1
+sphinx-external-toc~=0.3.1
attrs~=23.2.0
# keep support for numpy builtin type aliases for previous tags
From f90e128aa969d6db93574eb00e088260dcd2c869 Mon Sep 17 00:00:00 2001
From: Oliver Holworthy <1216955+oliverholworthy@users.noreply.github.com>
Date: Tue, 23 Apr 2024 12:11:14 +0100
Subject: [PATCH 5/6] Add sphinx_design dependency
---
requirements/docs.txt | 1 +
1 file changed, 1 insertion(+)
diff --git a/requirements/docs.txt b/requirements/docs.txt
index 26d57f22c..78ebf2d39 100644
--- a/requirements/docs.txt
+++ b/requirements/docs.txt
@@ -14,6 +14,7 @@ myst-nb~=0.17.2
linkify-it-py~=2.0.3
sphinx-external-toc~=0.3.1
attrs~=23.2.0
+sphinx_design~=0.5.0
# keep support for numpy builtin type aliases for previous tags
# numpy builtin aliases like np.str were removed in 1.24
From 8cd1c5bccbad74770d3bac5cddb8de9a782d2c4c Mon Sep 17 00:00:00 2001
From: Oliver Holworthy <1216955+oliverholworthy@users.noreply.github.com>
Date: Tue, 23 Apr 2024 13:49:37 +0100
Subject: [PATCH 6/6] remove old html_sidebars from conf.py
---
docs/source/conf.py | 1 -
1 file changed, 1 deletion(-)
diff --git a/docs/source/conf.py b/docs/source/conf.py
index af514da90..ec358118b 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -132,7 +132,6 @@
"merlin-core": ("https://nvidia-merlin.github.io/core/stable/", None),
}
-html_sidebars = {"**": ["versions.html"]}
html_baseurl = "https://nvidia-merlin.github.io/systems/stable/"
autodoc_inherit_docstrings = False