Skip to content

Commit

Permalink
[DOCS] Upgrade version of docs sphinx-book-theme dependency (#1789)
Browse files Browse the repository at this point in the history
Co-authored-by: Jay Chia <[email protected]@users.noreply.github.com>
  • Loading branch information
jaychia and Jay Chia authored Jan 17, 2024
1 parent 3bc33ca commit 88effa2
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion .github/release-drafter.yml
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ autolabeler:
- /.*\[CHORE\].*/
- label: documentation
title:
- /.*\[DOC\].*/
- /.*\[DOCS\].*/
files:
- '*.rst'
- '*.html'
Expand Down
4 changes: 3 additions & 1 deletion docs/source/_static/header.css
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down Expand Up @@ -92,5 +93,6 @@ body.no-scroll {
.header-container {
padding-left: 10vw;
padding-right: 10vw;
width: 100%;
}
}
6 changes: 2 additions & 4 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@

default_role = "py:obj"

html_context = {"default_mode": "light"}

extensions = [
"sphinx_reredirects",
"sphinx.ext.autodoc",
Expand Down Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions requirements-dev.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 88effa2

Please sign in to comment.