Changes to use docformatter (#93)

config/dpkg/changelog

@@ -2,4 +2,4 @@ dfimagetools (20240128-1) unstable; urgency=low
 
   * Auto-generated
 
- -- Log2Timeline maintainers <log2timeline-maintainers@googlegroups.com>  Sun, 28 Jan 2024 07:25:23 +0100
+ -- Log2Timeline maintainers <log2timeline-maintainers@googlegroups.com>  Sun, 28 Jan 2024 10:22:51 +0100

docs/conf.py

@@ -52,6 +52,7 @@
 # docstrings.
 napoleon_google_docstring = True
 napoleon_numpy_docstring = False
+napoleon_include_init_with_doc = True
 napoleon_include_private_with_doc = False
 napoleon_include_special_with_doc = True
 

pyproject.toml

@@ -1,3 +1,10 @@
 [build-system]
 requires = ["setuptools", "wheel"]
 build-backend = "setuptools.build_meta"
+
+[tool.docformatter]
+black = false
+non-cap = ["dfDateTime", "dfImageTools", "dfVFS"]
+non-strict = false
+wrap-summaries = 80
+wrap-descriptions = 80

tox.ini

@@ -1,5 +1,5 @@
 [tox]
-envlist = py3{7,8,9,10,11,12},coverage,docs,lint,wheel
+envlist = py3{7,8,9,10,11,12},coverage,docformatter,docs,lint,wheel
 
 [testenv]
 allowlist_externals = ./run_tests.py
@@ -25,6 +25,13 @@ commands =
   coverage: coverage xml
   wheel: python -m build --no-isolation --wheel
 
+[testenv:docformatter]
+usedevelop = True
+deps =
+  docformatter
+commands =
+  docformatter --in-place --recursive dfimagetools tests
+
 [testenv:docs]
 usedevelop = True
 deps =
@@ -45,10 +52,14 @@ setenv =
 deps =
   -rrequirements.txt
   -rtest_requirements.txt
+  docformatter
   pylint >= 3.0.0, < 3.1.0
+  setuptools
   yamllint >= 1.26.0
 commands =
+  docformatter --version
   pylint --version
   yamllint -v
+  docformatter --check --diff --recursive dfimagetools setup.py tests
   pylint --rcfile=.pylintrc dfimagetools setup.py tests
   yamllint -c .yamllint.yaml test_data

utils/update_release.sh

@@ -25,7 +25,7 @@ dfimagetools (${VERSION}-1) unstable; urgency=low
 EOT
 
 # Regenerate the API documentation.
-tox -edocs
+tox -edocformatter,docs
 
 exit ${EXIT_SUCCESS};