From bf58c03160aced1a6e9a025ffc8aa2e157e73d6c Mon Sep 17 00:00:00 2001 From: Cody Glassman Date: Wed, 9 Oct 2024 09:01:57 -0700 Subject: [PATCH 1/2] docs - update RTD theme --- docs/requirements.txt | 2 +- docs/source/_static/global.css | 3 +++ docs/source/conf.py | 11 ++++++++--- 3 files changed, 12 insertions(+), 4 deletions(-) create mode 100644 docs/source/_static/global.css diff --git a/docs/requirements.txt b/docs/requirements.txt index b4c67b2548..72620f3490 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -2,4 +2,4 @@ parse_cmake sphinx==7.1.2 docutils==0.18.1 jinja2==3.1.4 -sphinx_rtd_theme==1.3.0 +sphinx_rtd_theme==3.0.0 diff --git a/docs/source/_static/global.css b/docs/source/_static/global.css new file mode 100644 index 0000000000..01a533fc83 --- /dev/null +++ b/docs/source/_static/global.css @@ -0,0 +1,3 @@ +.version-switch select option { + color: black; +} diff --git a/docs/source/conf.py b/docs/source/conf.py index 4d43f98bbc..b34d5756c5 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -144,7 +144,8 @@ html_theme = 'sphinx_rtd_theme' # further. For a list of options available for each theme, see the # documentation. html_theme_options = { - 'navigation_with_keys': True + 'navigation_with_keys': True, + 'flyout_display': 'attached', } # Add any paths that contain custom themes here, relative to this directory. @@ -178,8 +179,12 @@ def setup(app): # 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' - ] + '_static' +] + +html_css_files = [ + 'global.css', +] # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied From ab682a9469594606f7a975a3dc09813de5306f0d Mon Sep 17 00:00:00 2001 From: Cody Glassman Date: Wed, 9 Oct 2024 09:54:48 -0700 Subject: [PATCH 2/2] upgrade theme to fix selector styling --- docs/requirements.txt | 2 +- docs/source/_static/global.css | 3 --- docs/source/conf.py | 4 ---- 3 files changed, 1 insertion(+), 8 deletions(-) delete mode 100644 docs/source/_static/global.css diff --git a/docs/requirements.txt b/docs/requirements.txt index 72620f3490..333fa4fcce 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -2,4 +2,4 @@ parse_cmake sphinx==7.1.2 docutils==0.18.1 jinja2==3.1.4 -sphinx_rtd_theme==3.0.0 +sphinx_rtd_theme==3.0.1 diff --git a/docs/source/_static/global.css b/docs/source/_static/global.css deleted file mode 100644 index 01a533fc83..0000000000 --- a/docs/source/_static/global.css +++ /dev/null @@ -1,3 +0,0 @@ -.version-switch select option { - color: black; -} diff --git a/docs/source/conf.py b/docs/source/conf.py index b34d5756c5..fbce7975da 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -182,10 +182,6 @@ html_static_path = [ '_static' ] -html_css_files = [ - 'global.css', -] - # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied # directly to the root of the documentation.