From 15bb4a7a2df41f6d895b3b34700e6fcb14b93fe9 Mon Sep 17 00:00:00 2001 From: Matthew Kwiecien Date: Tue, 20 Feb 2024 10:18:18 -0800 Subject: [PATCH] Adding new theme and adding some theme options. (#386) --- docs/conf.py | 17 ++++++++++------- docs/environment.yml | 2 +- 2 files changed, 11 insertions(+), 8 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 065c23c9..6033fee1 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -55,15 +55,18 @@ # -- Options for HTML output ------------------------------------------------- -# Attempt to generate a sidebar -html_sidebars = {"**": ["localtoc.html", "sourcelink.html", "searchbox.html"]} - # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -# -html_theme = "sphinx_rtd_theme" - -html_theme_options = {"collapse_navigation": False} +# To see how to further customize the theme, see: +# https://sphinx-book-theme.readthedocs.io/en/stable/index.html + +html_theme = "sphinx_book_theme" +html_theme_options = { + "collapse_navigation": False, + "repository_url": "https://github.com/LSSTDESC/firecrown", + "use_repository_button": True, +} +html_title = "firecrown" # 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/environment.yml b/docs/environment.yml index b34789cb..6285c37d 100644 --- a/docs/environment.yml +++ b/docs/environment.yml @@ -27,4 +27,4 @@ dependencies: - sphinx-autoapi - sphinx-autodoc-typehints - sphinxcontrib-apidoc - - sphinx_rtd_theme + - sphinx-book-theme