From 88effa2b21ed35c7eb25125c419f7ead6ed03bff Mon Sep 17 00:00:00 2001 From: Jay Chia <17691182+jaychia@users.noreply.github.com> Date: Wed, 17 Jan 2024 11:53:14 -0800 Subject: [PATCH] [DOCS] Upgrade version of docs sphinx-book-theme dependency (#1789) Co-authored-by: Jay Chia --- .github/release-drafter.yml | 2 +- docs/source/_static/header.css | 4 +++- docs/source/conf.py | 6 ++---- requirements-dev.txt | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/.github/release-drafter.yml b/.github/release-drafter.yml index 1025c92093..6656e1d6ad 100644 --- a/.github/release-drafter.yml +++ b/.github/release-drafter.yml @@ -63,7 +63,7 @@ autolabeler: - /.*\[CHORE\].*/ - label: documentation title: - - /.*\[DOC\].*/ + - /.*\[DOCS\].*/ files: - '*.rst' - '*.html' diff --git a/docs/source/_static/header.css b/docs/source/_static/header.css index 212e89245c..9759884cee 100644 --- a/docs/source/_static/header.css +++ b/docs/source/_static/header.css @@ -4,7 +4,8 @@ align-items: center; justify-content: space-between; padding: 24px; - border-bottom: 1px solid rgba(0,0,0,.1) + border-bottom: 1px solid rgba(0,0,0,.1); + width: 100%; } .header-nav { @@ -92,5 +93,6 @@ body.no-scroll { .header-container { padding-left: 10vw; padding-right: 10vw; + width: 100%; } } diff --git a/docs/source/conf.py b/docs/source/conf.py index b186fcb077..5005642255 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -27,6 +27,8 @@ default_role = "py:obj" +html_context = {"default_mode": "light"} + extensions = [ "sphinx_reredirects", "sphinx.ext.autodoc", @@ -54,12 +56,8 @@ html_static_path = ["_static"] html_css_files = ["header.css", "custom-function-signatures.css"] html_theme_options = { - # This is the footer of the primary sidebar as HTML - "extra_navbar": "", # This is how many levels are shown on the secondary sidebar "show_toc_level": 2, - # Remove title under the logo on the left sidebar - "logo_only": True, } # -- Copy button configuration diff --git a/requirements-dev.txt b/requirements-dev.txt index e75d90e79a..8be77c1a6e 100644 --- a/requirements-dev.txt +++ b/requirements-dev.txt @@ -58,8 +58,8 @@ gcsfs==2023.12.0; python_version >= '3.8' # Documentation myst-nb>=0.16.0 -Sphinx <= 5 -sphinx-book-theme>=0.3.3,<1.0.0 +Sphinx==5.3.0 +sphinx-book-theme==1.1.0; python_version >= "3.9" sphinx-reredirects>=0.1.1 sphinx-copybutton>=0.5.2 # sphinxcontrib-applehelp needs to be pinned as it dropped support for older versions of Sphinx