Skip to content

Commit

Permalink
docs refresh, support markdown && move to furo (#2131)
Browse files Browse the repository at this point in the history
  • Loading branch information
ewdurbin committed Aug 28, 2022
1 parent 2c3c073 commit 8e9dedc
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 9 deletions.
5 changes: 3 additions & 2 deletions docs-requirements.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
Sphinx
sphinx_rtd_theme
sphinx
myst-parser
furo
16 changes: 9 additions & 7 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
'sphinx.ext.autodoc',
'sphinx.ext.todo',
'sphinx.ext.viewcode',
'myst_parser',
]

templates_path = ['_templates']
Expand All @@ -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 ---------------------------------------------

Expand Down

0 comments on commit 8e9dedc

Please sign in to comment.