8000 Update Sphinx config by AA-Turner · Pull Request #898 · python/devguide · GitHub
[go: up one dir, main page]

Skip to content

Update Sphinx config #898

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 18 commits into from
Jul 12, 2022
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Reformat conf.py
  • Loading branch information
AA-Turner committed Jun 15, 2022
commit c0f309e1c8e0461d6874307ee8fb15ed17a1364a
27 changes: 18 additions & 9 deletions conf.py
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
import time

# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx_copybutton']
intersphinx_mapping = {'python': ('https://docs.python.org/3', None)}
todo_include_todos = True
extensions = [
'sphinx.ext.intersphinx',
'sphinx.ext.todo',
'sphinx_copybutton',
]

# The master toctree document.
master_doc = 'index'
Expand All @@ -15,10 +15,13 @@

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['_build', 'venv*', 'env*', 'README.rst', '.github']

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
exclude_patterns = [
'_build',
'venv*',
'env*',
'README.rst',
'.github',
]

# Use the upstream python-docs-theme
html_theme = 'furo'
Expand Down Expand Up @@ -49,3 +52,9 @@
'https://discuss.python.org/groups/moderators',
'https://discuss.python.org/groups/admins',
]

intersphinx_mapping = {
'python': ('https://docs.python.org/3', None),
}

todo_include_todos = True
0