Skip to content

Commit 6c1b1ef

Browse files
committed
When rendering docs, preserve the syntax for defaults. Fixes jaraco/path#197.
Incidentally, re-organize the extensions a bit for clarity.
1 parent bee975f commit 6c1b1ef

File tree

2 files changed

+11
-3
lines changed

2 files changed

+11
-3
lines changed

docs/conf.py

+10-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,15 @@
11
#!/usr/bin/env python3
22
# -*- coding: utf-8 -*-
33

4-
extensions = ['sphinx.ext.autodoc', 'jaraco.packaging.sphinx', 'rst.linker']
4+
extensions = [
5+
'sphinx.ext.autodoc',
6+
'jaraco.packaging.sphinx',
7+
]
58

69
master_doc = "index"
710

11+
# Link dates and other references in the changelog
12+
extensions += ['rst.linker']
813
link_files = {
914
'../CHANGES.rst': dict(
1015
using=dict(GH='https://github.com'),
@@ -25,7 +30,7 @@
2530
)
2631
}
2732

28-
# Be strict about any broken references:
33+
# Be strict about any broken references
2934
nitpicky = True
3035

3136
# Include Python intersphinx mapping to prevent failures
@@ -34,3 +39,6 @@
3439
intersphinx_mapping = {
3540
'python': ('https://docs.python.org/3', None),
3641
}
42+
43+
# Preserve authored syntax for defaults
44+
autodoc_preserve_defaults = True

setup.cfg

+1-1
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ testing =
4646

4747
docs =
4848
# upstream
49-
sphinx
49+
sphinx >= 3.5
5050
jaraco.packaging >= 9
5151
rst.linker >= 1.9
5252

0 commit comments

Comments
 (0)