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 b4f0ae6
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 3 deletions.
12 changes: 10 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -1,10 +1,15 @@
#!/usr/bin/env python3
# -*- coding: utf-8 -*-

extensions = ['sphinx.ext.autodoc', 'jaraco.packaging.sphinx', 'rst.linker']
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(GH='https://github.com'),
Expand All @@ -25,7 +30,7 @@
)
}

# Be strict about any broken references:
# Be strict about any broken references
nitpicky = True

# Include Python intersphinx mapping to prevent failures
Expand All @@ -34,3 +39,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 b4f0ae6

Please sign in to comment.