[WIP] Custom PyData theme

docs/source/_static/css/custom.css

@@ -0,0 +1,62 @@
+/* RAPIDS Custom Docs css */
+/* https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/styling.html#custom-css */
+
+body {
+    margin: 0;
+    padding: 0;
+}
+
+/* RAPIDS custom colors primary */
+
+html[data-theme="light"] {
+    --pst-color-primary: #7306ff;
+    --pst-color-secondary: #984dfb;
+    --pst-color-info: #ffb500;
+    --pst-color-danger: #d216d2;
+    --pst-color-target: #37c9dd;
+}
+
+html[data-theme="dark"] {
+    --pst-color-primary: #7306ff;
+    --pst-color-secondary: #984dfb;
+    --pst-color-info: #ffb500;
+    --pst-color-danger: #d216d2;
+    --pst-color-target: #37c9dd;
+}
+
+/* PyData Overrides */
+.bd-header-announcement {
+    background-color: #7400ff !important;
+    position: fixed;
+    padding: 0;
+    align-items: center;
+    justify-content: flex-start;
+    width: 100%;
+    max-height: 3rem;
+}
+
+.bd-header {
+    top: 3rem;
+    z-index: 4000;
+}
+
+.bd-sidebar-primary {
+    margin-top: 3rem;
+}
+
+.bd-header-announcement:after {
+    background-color: #7400ff;
+    z-index: 4000;
+}
+
+/* RAPIDS Nav Bar Styles */
+.rapids-nav-logo-container {
+    padding: 0.5rem 0.75rem;
+    cursor: pointer;
+
+}
+
+.rapids-nav-logo {
+    height: 2.5rem;
+    max-width: 100%;
+}

docs/source/conf.py

@@ -15,6 +15,9 @@
 # The full version, including alpha/beta/rc tags
 release = '23.08.00'
 
+# Allow errors in all notebooks by setting this option
+# https://nbsphinx.readthedocs.io/en/0.2.7/allow-errors.html
+# 
 nbsphinx_allow_errors = True
 
 
@@ -51,32 +54,45 @@
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 
+# Output file base name for HTML help builder. Default is 'pydoc'
+#
+htmlhelp_basename = "cuxfilterdoc"
+
 # -- Options for HTML output -------------------------------------------------
 
-# The theme to use for HTML and HTML Help pages.  See the documentation for
-# a list of builtin themes.
+# PyData Theme Options
+# https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html
 #
 html_theme = "pydata_sphinx_theme"
-html_logo = "_static/rapids_logo.png"
 html_static_path = ["_static"]
-
-# Removes sidebar
-htmlhelp_basename = "cuxfilterdoc"
-
-html_sidebars = {
-  "user_guide/index": []
-}
+html_css_files = ['css/custom.css'] # temp
 
 html_theme_options = {
-    "external_links": [],
+    "logo": {"text": project},
+    "external_links": [
+        {"name": "Ecosystem", "url": "https://rapids.ai/ecosystem"},
+        {"name": "Learn More", "url": "https://rapids.ai/learn-more"},
+        {"name": "News", "url": "https://rapids.ai/news"},
+        {"name": "User Guides", "url": "https://rapids.ai/user-guides"},
+        {"name": "API Docs", "url": "https://rapids.ai/api"},
+        {"name": "Install", "url": "https://rapids.ai/install"}
+    ],
+    "header_links_before_dropdown": 2, # note: change based on number of top level directories
+    "announcement": "https://raw.githubusercontent.com/rapidsai/sphinx-theme/main/_static/rapids-nav.html", # static
     "icon_links": [],
-    "github_url": "https://github.com/rapidsai/cuxfilter",
+    "github_url": f"https://github.com/rapidsai/{project}",
     "twitter_url": "https://twitter.com/rapidsai",
-    "show_toc_level": 1,
-    "navbar_align": "right",
+    "show_toc_level": 2,
+    "navbar_align": "left",
+    "navbar_start": ["navbar-logo", "version-switcher"],
+    "navbar_center": ["navbar-nav"],
+    "navbar_end": ["theme-switcher.html","navbar-icon-links.html"],
+    "switcher": { 
+        "version_match": version,
+        "json_url": f"https://raw.githubusercontent.com/rapidsai/sphinx-theme/main/_static/versions/{project}-doc-versions.json"
+    }
 }
 
 
-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")
+# NOTE TO DO:
+# works well, but need to fix scroll behavior and z index