Skip to content

Commit c18b908

Browse files
committed
change html theme to pydata_sphinx_theme
* toctree is now hidden because the added content is automatically added to the center navbar in the top
1 parent 2742c73 commit c18b908

File tree

3 files changed

+5
-8
lines changed

3 files changed

+5
-8
lines changed

docs/requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
sphinx
2-
sphinx_rtd_theme
32
sphinx-gallery
43
sphinx-toggleprompt
4+
pydata-sphinx-theme

docs/src/conf.py

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,6 @@
1414
import sys
1515
from datetime import datetime
1616

17-
import sphinx_rtd_theme
18-
1917
import skmatter
2018

2119

@@ -87,19 +85,19 @@
8785

8886
# The theme to use for HTML and HTML Help pages. See the documentation for
8987
# a list of builtin themes.
90-
html_theme = "sphinx_rtd_theme"
88+
html_theme = "pydata_sphinx_theme"
9189

9290
# Theme options are theme-specific and customize the look and feel of a theme
9391
# further. For a list of options available for each theme, see the
9492
# documentation.
9593
# html_theme_options = {}
9694

9795
# Add any paths that contain custom themes here, relative to this directory.
98-
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
96+
# html_theme_path = []
9997

10098
# The name for this set of Sphinx documents. If None, it defaults to
10199
# "<project> v<release> documentation".
102-
# html_title = None
100+
html_title = f"{project} v{release}"
103101

104102
# A shorter title for the navigation bar. Default is the same as html_title.
105103
# html_short_title = None

docs/src/index.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,7 @@
55
:end-before: marker-contributing
66

77
.. toctree::
8-
:maxdepth: 1
9-
:caption: Contents:
8+
:hidden:
109

1110
getting-started
1211
installation

0 commit comments

Comments
 (0)