Skip to content

Commit 0e34b57

Browse files
committed
Update config files.
1 parent c5a8fe1 commit 0e34b57

File tree

4 files changed

+44
-60
lines changed

4 files changed

+44
-60
lines changed

.pre-commit-config.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ repos:
5555

5656

5757
- repo: https://github.com/domdfcoding/yapf-isort
58-
rev: v0.3.0
58+
rev: v0.3.2
5959
hooks:
6060
- id: yapf-isort
6161
exclude: ^(doc-source/conf|__pkginfo__|make_conda_recipe|setup)\.py$

doc-source/conf.py

Lines changed: 42 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -10,19 +10,19 @@
1010
sys.path.append(os.path.abspath('.'))
1111
sys.path.append(os.path.abspath('..'))
1212

13+
# 3rd party
14+
import domdf_python_tools
15+
16+
# this package
1317
from __pkginfo__ import __version__
1418

15-
# User-configurable lines
16-
import domdf_python_tools
1719
domdf_python_tools.__docs = True
1820
overloads_location = "bottom"
19-
# End of user-configurable lines
2021

2122
github_username = "domdfcoding"
2223
github_repository = "domdf_python_tools"
2324
github_url = f"https://github.com/{github_username}/{github_repository}"
2425

25-
2626
rst_prolog = f""".. |pkgname| replace:: domdf_python_tools
2727
.. |pkgname2| replace:: ``domdf_python_tools``
2828
.. |browse_github| replace:: `Browse the GitHub Repository <{github_url}>`__
@@ -37,22 +37,22 @@
3737
package_root = "domdf_python_tools"
3838

3939
extensions = [
40-
'sphinx_toolbox',
41-
'sphinx_toolbox.more_autodoc',
42-
'sphinx_toolbox.more_autosummary',
43-
'sphinx_toolbox.tweaks.param_dash',
44-
'sphinx.ext.intersphinx',
45-
'sphinx.ext.mathjax',
46-
'sphinxcontrib.httpdomain',
47-
'sphinxcontrib.extras_require',
48-
'sphinx.ext.todo',
49-
'sphinxemoji.sphinxemoji',
50-
'notfound.extension',
51-
'sphinx_copybutton',
52-
'sphinxcontrib.default_values',
53-
'sphinxcontrib.toctree_plus',
54-
'seed_intersphinx_mapping',
55-
]
40+
'sphinx_toolbox',
41+
'sphinx_toolbox.more_autodoc',
42+
'sphinx_toolbox.more_autosummary',
43+
'sphinx_toolbox.tweaks.param_dash',
44+
'sphinx.ext.intersphinx',
45+
'sphinx.ext.mathjax',
46+
'sphinxcontrib.httpdomain',
47+
'sphinxcontrib.extras_require',
48+
'sphinx.ext.todo',
49+
'sphinxemoji.sphinxemoji',
50+
'notfound.extension',
51+
'sphinx_copybutton',
52+
'sphinxcontrib.default_values',
53+
'sphinxcontrib.toctree_plus',
54+
'seed_intersphinx_mapping',
55+
]
5656

5757
sphinxemoji_style = 'twemoji'
5858
todo_include_todos = bool(os.environ.get("SHOW_TODOS", 0))
@@ -113,29 +113,31 @@
113113
}
114114

115115
add_module_names = False
116-
117-
116+
hide_none_rtype = True
117+
118+
119+
autodoc_exclude_members = [ # Exclude "standard" methods.
120+
"__dict__",
121+
"__class__",
122+
"__dir__",
123+
"__weakref__",
124+
"__module__",
125+
"__annotations__",
126+
"__orig_bases__",
127+
"__parameters__",
128+
"__subclasshook__",
129+
"__init_subclass__",
130+
"__attrs_attrs__",
131+
"__init__",
132+
"__new__",
133+
"__getnewargs__",
134+
"__abstractmethods__",
135+
"__hash__",
136+
]
118137
autodoc_default_options = {
119138
'members': None, # Include all members (methods).
120139
'special-members': None,
121140
"autosummary": None,
122141
"show-inheritance": None,
123-
'exclude-members': ','.join([ # Exclude "standard" methods.
124-
"__dict__",
125-
"__class__",
126-
"__dir__",
127-
"__weakref__",
128-
"__module__",
129-
"__annotations__",
130-
"__orig_bases__",
131-
"__parameters__",
132-
"__subclasshook__",
133-
"__init_subclass__",
134-
"__attrs_attrs__",
135-
"__init__",
136-
"__new__",
137-
"__getnewargs__",
138-
"__abstractmethods__",
139-
"__hash__",
140-
]),
142+
'exclude-members': ','.join(autodoc_exclude_members),
141143
}

tests/requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
coverage>=5.1
2-
coverage_pyver_pragma>=0.0.5
2+
coverage_pyver_pragma>=0.0.6
33
faker>=4.1.2
44
pandas>=1.0.0; implementation_name == "cpython" and python_version < "3.9"
55
pytest>=6.0.0

tox.ini

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -209,21 +209,3 @@ package = domdf_python_tools
209209
[pytest]
210210
addopts = --color yes --durations 25
211211
timeout = 300
212-
213-
[testenv:isort]
214-
basepython = python3.6
215-
skip_install = true
216-
ignore_errors = true
217-
changedir = {toxinidir}
218-
deps = isort >=5.1.4
219-
commands = isort domdf_python_tools tests
220-
221-
222-
223-
[testenv:qa]
224-
basepython = python3.6
225-
skip_install = True
226-
ignore_errors = true
227-
whitelist_externals = tox
228-
changedir = {toxinidir}
229-
commands = tox -e pyup,isort,yapf,mypy,lint {posargs}

0 commit comments

Comments
 (0)