diff options
author | Jason R. Coombs <jaraco@jaraco.com> | 2021-11-14 17:41:08 -0500 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-11-14 17:41:08 -0500 |
commit | 5b75de07169ef13952a5ab48e0b8bc15f31d0c37 (patch) | |
tree | 13b02b20c66d6f5fca7905285ee609a5ad72acb6 /docs/conf.py | |
parent | 6fc5d3099898fc3d06bcf72f1f6607d02124d60f (diff) | |
parent | 5141c4210c2a63a3bb54f0f512e4116faedc8d63 (diff) | |
download | python-setuptools-git-debt/remove-legacy-version.tar.gz |
Merge branch 'main' into debt/remove-legacy-versiondebt/remove-legacy-version
Diffstat (limited to 'docs/conf.py')
-rw-r--r-- | docs/conf.py | 27 |
1 files changed, 25 insertions, 2 deletions
diff --git a/docs/conf.py b/docs/conf.py index 8f1e1f4c..d352a481 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -76,17 +76,24 @@ link_files = { # Be strict about any broken references: nitpicky = True +# Include Python intersphinx mapping to prevent failures +# jaraco/skeleton#51 +extensions += ['sphinx.ext.intersphinx'] intersphinx_mapping = { - 'pypa-build': ('https://pypa-build.readthedocs.io/en/latest/', None) + 'python': ('https://docs.python.org/3', None), } +intersphinx_mapping.update({ + 'pypa-build': ('https://pypa-build.readthedocs.io/en/latest/', None) +}) + # Add support for linking usernames github_url = 'https://github.com' github_sponsors_url = f'{github_url}/sponsors' extlinks = { 'user': (f'{github_sponsors_url}/%s', '@'), # noqa: WPS323 } -extensions += ['sphinx.ext.extlinks', 'sphinx.ext.intersphinx'] +extensions += ['sphinx.ext.extlinks'] # Ref: https://github.com/python-attrs/attrs/pull/571/files\ # #diff-85987f48f1258d9ee486e3191495582dR82 @@ -94,6 +101,20 @@ default_role = 'any' # HTML theme html_theme = 'furo' +html_logo = "images/logo.png" +html_favicon = "images/favicon.ico" + +html_theme_options = { + "sidebar_hide_name": True, + "light_css_variables": { + "color-brand-primary": "#336790", # "blue" + "color-brand-content": "#336790", + }, + "dark_css_variables": { + "color-brand-primary": "#E5B62F", # "yellow" + "color-brand-content": "#E5B62F", + }, +} # Add support for inline tabs extensions += ['sphinx_inline_tabs'] @@ -150,3 +171,5 @@ towncrier_draft_working_directory = '..' towncrier_draft_include_empty = False extensions += ['jaraco.tidelift'] + +intersphinx_mapping['pip'] = 'https://pip.pypa.io/en/latest', None |