Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: use PyData theme #85

Merged
merged 1 commit into from
Jul 6, 2024
+10 −21
Merged

docs: use PyData theme #85

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 3 additions & 15 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
13 changes: 7 additions & 6 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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)
Expand All @@ -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
Expand All @@ -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
Expand Down