PT Sphinx Theme Test (#600)

Author: sekyondaMeta

docs/_static/helion_logo.png

@@ -9,6 +9,8 @@
 from typing import Callable
 from typing import Protocol
 
+import pytorch_sphinx_theme2  # pyright: ignore[reportMissingImports]
+
 # -- Path setup --------------------------------------------------------------
 
 
@@ -22,7 +24,7 @@ def connect(self, event: str, callback: Callable[..., None]) -> None:
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here.
-sys.path.insert(0, os.path.abspath(".."))
+sys.path.insert(0, os.path.abspath("."))
 
 # -- Project information -----------------------------------------------------
 
@@ -39,6 +41,11 @@ def connect(self, event: str, callback: Callable[..., None]) -> None:
     "myst_parser",
     "sphinx_autodoc_typehints",
     "sphinx_gallery.gen_gallery",
+    "sphinx_design",
+    "sphinx_sitemap",
+    "sphinxcontrib.mermaid",
+    "pytorch_sphinx_theme2",
+    "sphinxext.opengraph",
 ]
 
 # MyST parser configuration
@@ -81,7 +88,83 @@ def connect(self, event: str, callback: Callable[..., None]) -> None:
 
 # -- Options for HTML output -------------------------------------------------
 
-html_theme = "sphinx_rtd_theme"
+html_theme = "pytorch_sphinx_theme2"
+html_theme_path = [pytorch_sphinx_theme2.get_html_theme_path()]
+
+html_theme_options = {
+    "navigation_with_keys": False,
+    "analytics_id": "GTM-T8XT4PS",
+    "show_lf_header": False,
+    "show_lf_footer": False,
+    "logo": {
+        "text": "",
+        "image_light": "_static/helion_logo.png",
+        "image_dark": "_static/helion_logo.png",
+    },
+    "icon_links": [
+        {
+            "name": "X",
+            "url": "https://x.com/PyTorch",
+            "icon": "fa-brands fa-x-twitter",
+        },
+        {
+            "name": "GitHub",
+            "url": "https://github.com/pytorch/helion",
+            "icon": "fa-brands fa-github",
+        },
+        {
+            "name": "Discourse",
+            "url": "https://dev-discuss.pytorch.org/",
+            "icon": "fa-brands fa-discourse",
+        },
+        {
+            "name": "PyPi",
+            "url": "https://pypi.org/project/helion",
+            "icon": "fa-brands fa-python",
+        },
+    ],
+    "use_edit_page_button": True,
+    "navbar_center": "navbar-nav",
+}
+
+theme_variables = pytorch_sphinx_theme2.get_theme_variables()
+templates_path = [
+    "_templates",
+    os.path.join(os.path.dirname(pytorch_sphinx_theme2.__file__), "templates"),
+]
+
+html_context = {
+    "theme_variables": theme_variables,
+    "display_github": True,
+    "github_url": "https://github.com",
+    "github_user": "pytorch",
+    "github_repo": "helion",
+    "feedback_url": "https://github.com/pytorch/helion",
+    "github_version": "main",
+    "doc_path": "docs/",
+    "library_links": [
+        {
+            "name": "Helion",
+            "url": "https://pytorch.github.io/helion/",
+            "current": True,
+        },
+        {
+            "name": "torch.compiler",
+            "url": "https://pytorch.org/docs/stable/torch.compiler.html",
+        },
+        {
+            "name": "PyTorch",
+            "url": "https://pytorch.org/docs/stable/",
+        },
+        {
+            "name": "Triton",
+            "url": "https://triton-lang.org/main/",
+        },
+    ],
+    "community_links": theme_variables.get("community_links", []),
+    "language_bindings_links": html_theme_options.get("language_bindings_links", []),
+}
+
 html_static_path = ["_static"]
 
 # Output directory for HTML files

docs/conf.py

@@ -29,13 +29,20 @@ dev = [
     "pre-commit"
 ]
 docs = [
-    "sphinx",
+    "sphinx==7.2.6",
+    "pytorch_sphinx_theme2 @ git+https://github.com/pytorch/pytorch_sphinx_theme.git@pytorch_sphinx_theme2#egg=pytorch_sphinx_theme2",
+    "sphinxcontrib.katex==0.9.10",
+    "docutils==0.18.1,<0.21",
+    "sphinx-design==0.6.1",
+    "sphinxcontrib-mermaid==1.0.0",
     "myst-parser",
-    "sphinx-rtd-theme",
+    "sphinx-gallery==0.14.0",
+    "sphinx-sitemap==2.7.1",
     "sphinx-autodoc-typehints",
     "linkify-it-py",
     "sphinx-autobuild",
-    "sphinx-gallery"
+    "sphinxext-opengraph",
+    "pillow",
 ]
 
 [project.urls]