Skip to content

Commit

Permalink
When rendering docs, preserve the syntax for defaults. Fixes jaraco/p…
Browse files Browse the repository at this point in the history
…ath#197.

Incidentally, re-organize the extensions a bit for clarity.
  • Loading branch information
jaraco committed Sep 25, 2022
1 parent 27c5534 commit 92fd50c
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 2 deletions.
9 changes: 8 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
#!/usr/bin/env python3
# -*- coding: utf-8 -*-

extensions = ['sphinx.ext.autodoc', 'jaraco.packaging.sphinx', 'rst.linker']
extensions = [
'sphinx.ext.autodoc',
'jaraco.packaging.sphinx',
'rst.linker',
]

master_doc = "index"

Expand Down Expand Up @@ -34,3 +38,6 @@
intersphinx_mapping = {
'python': ('https://docs.python.org/3', None),
}

# Preserve authored syntax for defaults
autodoc_preserve_defaults = True
2 changes: 1 addition & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ testing =

docs =
# upstream
sphinx
sphinx >= 3.5
jaraco.packaging >= 9
rst.linker >= 1.9

Expand Down

0 comments on commit 92fd50c

Please sign in to comment.