From 5c2172a7aa99bfab0f19b9eba57900958e0d9641 Mon Sep 17 00:00:00 2001 From: Alexander Condello Date: Fri, 12 Jul 2024 08:41:33 -0700 Subject: [PATCH] Build locally with the same sphinx theme as the sdk --- docs/conf.py | 28 ++++++---------------------- docs/requirements.txt | 5 ++--- 2 files changed, 8 insertions(+), 25 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index f58415df..b71f9b87 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -85,31 +85,15 @@ """ -# -- Breath --------------------------------------------------------------- - -# breathe_default_project = "dwave.optimization" -# breathe_projects = dict( -# optimization=os.path.join(config_directory, 'build-cpp', 'xml'), -# ) - -# see https://breathe.readthedocs.io/en/latest/readthedocs.html -# if os.environ.get('READTHEDOCS', False): -# subprocess.call('make cpp', shell=True, cwd=config_directory) - # -- Options for HTML output ---------------------------------------------- -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -# -import sphinx_rtd_theme -html_theme = 'sphinx_rtd_theme' -html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] +html_theme = "pydata_sphinx_theme" -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -# -# html_theme_options = {} +html_theme_options = { + "collapse_navigation": True, + "show_prev_next": False, +} +html_sidebars = {"**": ["search-field", "sidebar-nav-bs"]} # remove ads # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, diff --git a/docs/requirements.txt b/docs/requirements.txt index aab40801..d094c0c2 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,3 +1,2 @@ -sphinx -sphinx_rtd_theme -sphinx-design==0.5.0 +pydata-sphinx-theme==0.14.3 +sphinx==7.3.7