From 8e9dedc5794e27f07777f6c075484331b810df4e Mon Sep 17 00:00:00 2001 From: Ee Durbin Date: Sun, 28 Aug 2022 08:12:39 -0400 Subject: [PATCH] docs refresh, support markdown && move to furo (#2131) --- docs-requirements.txt | 5 +++-- docs/source/conf.py | 16 +++++++++------- 2 files changed, 12 insertions(+), 9 deletions(-) diff --git a/docs-requirements.txt b/docs-requirements.txt index ab3f3dd41..db72b7bd7 100644 --- a/docs-requirements.txt +++ b/docs-requirements.txt @@ -1,2 +1,3 @@ -Sphinx -sphinx_rtd_theme +sphinx +myst-parser +furo diff --git a/docs/source/conf.py b/docs/source/conf.py index fa64cc897..00477aaa3 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -8,6 +8,7 @@ 'sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.viewcode', + 'myst_parser', ] templates_path = ['_templates'] @@ -22,18 +23,19 @@ # The full version, including alpha/beta/rc tags. release = '1.0' +html_title = 'Python.org Website' + pygments_style = 'sphinx' -try: - import sphinx_rtd_theme -except ImportError: - html_theme = 'default' -else: - html_theme = 'sphinx_rtd_theme' - html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] +html_theme = "furo" htmlhelp_basename = 'PythonorgWebsitedoc' +source_suffix = { + '.rst': 'restructuredtext', + '.md': 'markdown', +} + # -- Options for LaTeX output ---------------------------------------------