Skip to content

Commit

Permalink
Build locally with the same sphinx theme as the sdk
Browse files Browse the repository at this point in the history
  • Loading branch information
arcondello committed Jul 12, 2024
1 parent c711e35 commit 5c2172a
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 25 deletions.
28 changes: 6 additions & 22 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
5 changes: 2 additions & 3 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,2 @@
sphinx
sphinx_rtd_theme
sphinx-design==0.5.0
pydata-sphinx-theme==0.14.3
sphinx==7.3.7

0 comments on commit 5c2172a

Please sign in to comment.