Skip to content

Commit 92fd50c

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 27c5534 commit 92fd50c

File tree

2 files changed

+9
-2
lines changed

2 files changed

+9
-2
lines changed

docs/conf.py

+8-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
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+
'rst.linker',
8+
]
59

610
master_doc = "index"
711

@@ -34,3 +38,6 @@
3438
intersphinx_mapping = {
3539
'python': ('https://docs.python.org/3', None),
3640
}
41+
42+
# Preserve authored syntax for defaults
43+
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)