Adding new theme and adding some theme options. (#386)

LSSTDESC · Feb 20, 2024 · 15bb4a7 · 15bb4a7
1 parent d92a72d
commit 15bb4a7
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 8 deletions.
diff --git 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
@@ -27,4 +27,4 @@ dependencies:
   - sphinx-autoapi
   - sphinx-autodoc-typehints
   - sphinxcontrib-apidoc
-  - sphinx_rtd_theme
+  - sphinx-book-theme