docs: use PyData theme (#85)

wcxve · Jul 6, 2024 · 28bb274 · 28bb274
1 parent cb065ce
commit 28bb274
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 21 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -51,27 +51,15 @@
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-html_theme = 'sphinx_book_theme'
+html_theme = 'pydata_sphinx_theme'
 html_theme_options = {
     'github_url': 'https://github.com/wcxve/elisa',
-    'repository_url': 'https://github.com/wcxve/elisa',
-    'repository_branch': 'main',
-    'path_to_docs': 'docs',
-    'launch_buttons': {
-        'binderhub_url': 'https://mybinder.org',
-        'colab_url': 'https://colab.research.google.com/',
-        'notebook_interface': 'jupyterlab',
-    },
-    'navigation_with_keys': False,
-    'use_edit_page_button': True,
-    'use_repository_button': True,
-    'use_download_button': True,
-    'use_issues_button': True,
+    'show_nav_level': 2,
 }
 html_title = 'ELISA'
 html_static_path = ['_static']
 html_css_files = ['custom.css']
-html_logo = '_static/logo2.png'
+html_logo = '_static/logo1.png'
 html_favicon = '_static/favicon.svg'
 html_baseurl = 'https://elisa-lib.readthedocs.io/en/latest/'
 html_show_sourcelink = False

diff --git a/docs/index.md b/docs/index.md
@@ -1,3 +1,7 @@
+---
+html_theme.sidebar_secondary.remove:
+---
+
 # ELISA: Efficient Library for Spectral Analysis in High-Energy Astrophysics
 
 [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/elisa-lib?color=blue&logo=Python&logoColor=white&style=for-the-badge)](https://pypi.org/project/elisa-lib)
@@ -15,9 +19,6 @@ The key features of ``ELISA`` include:
 - **Performance**: Efficient computation backend based on [JAX](https://jax.readthedocs.io/en/latest/notebooks/quickstart.html)
 - ...
 
-**NOTE**: The documentations of ``ELISA`` is a work in progress. If you have any
-questions or suggestions, please feel free to open an issue on the [GitHub issues page](https://github.com/wcxve/elisa/issues).
-
 ```{admonition} How to find your way around?
 :class: tip
 
@@ -33,14 +34,14 @@ and tricks.
 stumble upon bugs, we’d love your input! Check out our {ref}`contributing`
 section and share your findings on the
 [GitHub issues page](https://github.com/wcxve/elisa/issues).
-
-👈 Take a peek at the sidebar for the full table of contents.
 ```
 
-## Table of contents
+**NOTE**: The documentations of ``ELISA`` is a work in progress. If you have any
+questions or suggestions, please feel free to open an issue on the [GitHub issues page](https://github.com/wcxve/elisa/issues).
 
 ```{toctree}
 :maxdepth: 2
+:hidden:
 
 guide
 tutorials