Skip to content

Commit 8e9dedc

Browse files
authored
docs refresh, support markdown && move to furo (#2131)
1 parent 2c3c073 commit 8e9dedc

File tree

2 files changed

+12
-9
lines changed

2 files changed

+12
-9
lines changed

docs-requirements.txt

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
1-
Sphinx
2-
sphinx_rtd_theme
1+
sphinx
2+
myst-parser
3+
furo

docs/source/conf.py

+9-7
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
'sphinx.ext.autodoc',
99
'sphinx.ext.todo',
1010
'sphinx.ext.viewcode',
11+
'myst_parser',
1112
]
1213

1314
templates_path = ['_templates']
@@ -22,18 +23,19 @@
2223
# The full version, including alpha/beta/rc tags.
2324
release = '1.0'
2425

26+
html_title = 'Python.org Website'
27+
2528
pygments_style = 'sphinx'
2629

27-
try:
28-
import sphinx_rtd_theme
29-
except ImportError:
30-
html_theme = 'default'
31-
else:
32-
html_theme = 'sphinx_rtd_theme'
33-
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
30+
html_theme = "furo"
3431

3532
htmlhelp_basename = 'PythonorgWebsitedoc'
3633

34+
source_suffix = {
35+
'.rst': 'restructuredtext',
36+
'.md': 'markdown',
37+
}
38+
3739

3840
# -- Options for LaTeX output ---------------------------------------------
3941

0 commit comments

Comments
 (0)