Skip to content

Commit 423d713

Browse files
authored
Change documentation theme (#101)
* Use sphinx-book-theme Signed-off-by: Pavithra Eswaramoorthy <pavithraes@outlook.com>
1 parent 5ba7896 commit 423d713

File tree

2 files changed

+17
-2
lines changed

2 files changed

+17
-2
lines changed

docs/conf.py

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616

1717
extensions = [
1818
'myst_nb',
19+
'sphinx_copybutton',
1920
]
2021

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

29-
html_theme = 'alabaster'
30-
html_static_path = []
30+
html_theme = 'sphinx_book_theme'
31+
html_title = 'JAX AI Stack'
32+
html_static_path = ['']
33+
34+
# Theme-specific options
35+
# https://sphinx-book-theme.readthedocs.io/en/stable/reference.html
36+
html_theme_options = {
37+
'show_navbar_depth': 2,
38+
'show_toc_level': 2,
39+
'repository_url': 'https://github.com/jax-ml/jax-ai-stack',
40+
'path_to_docs': 'docs/',
41+
'use_repository_button': True,
42+
'navigation_with_keys': True,
43+
}
3144

3245
exclude_patterns = [
3346
# Sometimes sphinx reads its own outputs as inputs!

docs/requirements.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
sphinx
33
myst-nb
44
myst-parser[linkify]
5+
sphinx-book-theme
6+
sphinx-copybutton
57

68
# Packages required for notebook execution
79
matplotlib

0 commit comments

Comments
 (0)