diff options
author | Jason R. Coombs <jaraco@jaraco.com> | 2022-09-26 20:49:49 -0400 |
---|---|---|
committer | Jason R. Coombs <jaraco@jaraco.com> | 2022-09-26 20:49:49 -0400 |
commit | badd7064e202635b8a94d5603b31a37ca7d58d6c (patch) | |
tree | da76a3c2c49d17af68186e43178fe937b3199992 /docs | |
parent | a86428cfef419e9ef3f04a04bde2d64d395936b8 (diff) | |
parent | b4f0ae621594316e56cede2856b6a5be605a893c (diff) | |
download | python-setuptools-git-badd7064e202635b8a94d5603b31a37ca7d58d6c.tar.gz |
Merge https://github.com/jaraco/skeleton
# Conflicts:
# .github/workflows/main.yml
# docs/conf.py
Diffstat (limited to 'docs')
-rw-r--r-- | docs/conf.py | 15 |
1 files changed, 13 insertions, 2 deletions
diff --git a/docs/conf.py b/docs/conf.py index 2b60bf57..ecd7aac4 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,7 +1,15 @@ -extensions = ['sphinx.ext.autodoc', 'jaraco.packaging.sphinx', 'rst.linker'] +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- + +extensions = [ + 'sphinx.ext.autodoc', + 'jaraco.packaging.sphinx', +] master_doc = "index" +# Link dates and other references in the changelog +extensions += ['rst.linker'] link_files = { '../CHANGES.rst': dict( using=dict( @@ -81,7 +89,7 @@ link_files = { ), } -# Be strict about any broken references: +# Be strict about any broken references nitpicky = True # Include Python intersphinx mapping to prevent failures @@ -91,6 +99,9 @@ intersphinx_mapping = { 'python': ('https://docs.python.org/3', None), } +# Preserve authored syntax for defaults +autodoc_preserve_defaults = True + intersphinx_mapping.update({ 'pip': ('https://pip.pypa.io/en/latest', None), 'build': ('https://pypa-build.readthedocs.io/en/latest', None), |