Skip to content

Commit 32e3d76

Browse files
committed
Copier Template: Documentation Configuration: Backport changes from 'dynadoc' project.
Also, * Copier Template: Tell Pyright language server to ignore code in 'documentation' directory.
1 parent 1faba6d commit 32e3d76

2 files changed

Lines changed: 9 additions & 6 deletions

File tree

template/documentation/conf.py.jinja

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
# vim: set filetype=python fileencoding=utf-8:
2+
# -*- mode: python ; coding: utf-8 -*-
3+
14
''' Configuration file for the Sphinx documentation builder.
25
36
This file only contains a selection of the most common options.
@@ -94,7 +97,7 @@ linkcheck_ignore = [
9497
# Package does not exist during initial development.
9598
r'https://pypi.org/project/{{ package_name }}/',
9699
# Github aggressively rate-limits access to certain blobs.
97-
r'https://github\.com/emcd/python-project-common/blob/.*'
100+
r'https://github\.com/.*/.*/blob/.*',
98101
]
99102

100103
# -- Options for HTML output -------------------------------------------------
@@ -114,13 +117,13 @@ html_static_path = [ '_static' ]
114117

115118
autodoc_default_options = {
116119
'member-order': 'groupwise',
117-
'imported-members': False,
118-
'inherited-members': True,
120+
'members': True,
119121
'show-inheritance': True,
120-
'undoc-members': True,
122+
# 'special-members': '__call__',
121123
}
122124

123-
#autodoc_typehints = 'description'
125+
autodoc_typehints = 'none'
126+
autodoc_use_type_comments = False
124127

125128
# -- Options for intersphinx extension ---------------------------------------
126129
# https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#configuration

template/pyproject.toml.jinja

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -255,7 +255,7 @@ strict = false
255255

256256
# https://microsoft.github.io/pyright/#/configuration
257257
[tool.pyright]
258-
ignore = [ 'tests' ] # Stronger hint for language server.
258+
ignore = [ 'documentation', 'tests' ] # Stronger hint for language server.
259259
include = [ 'sources' ]
260260
reportConstantRedefinition = true
261261
reportInvalidTypeVarUse = true

0 commit comments

Comments
 (0)