Skip to content

Commit

Permalink
Change documentation theme (#101)
Browse files Browse the repository at this point in the history
* Use sphinx-book-theme

Signed-off-by: Pavithra Eswaramoorthy <pavithraes@outlook.com>
  • Loading branch information
pavithraes authored Nov 19, 2024
1 parent 5ba7896 commit 423d713
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 2 deletions.
17 changes: 15 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@

extensions = [
'myst_nb',
'sphinx_copybutton',
]

templates_path = ['_templates']
Expand All @@ -26,8 +27,20 @@
# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

html_theme = 'alabaster'
html_static_path = []
html_theme = 'sphinx_book_theme'
html_title = 'JAX AI Stack'
html_static_path = ['']

# Theme-specific options
# https://sphinx-book-theme.readthedocs.io/en/stable/reference.html
html_theme_options = {
'show_navbar_depth': 2,
'show_toc_level': 2,
'repository_url': 'https://github.com/jax-ml/jax-ai-stack',
'path_to_docs': 'docs/',
'use_repository_button': True,
'navigation_with_keys': True,
}

exclude_patterns = [
# Sometimes sphinx reads its own outputs as inputs!
Expand Down
2 changes: 2 additions & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
sphinx
myst-nb
myst-parser[linkify]
sphinx-book-theme
sphinx-copybutton

# Packages required for notebook execution
matplotlib
Expand Down

0 comments on commit 423d713

Please sign in to comment.