Skip to content

Commit

Permalink
Changes to use docformatter
Browse files Browse the repository at this point in the history
  • Loading branch information
joachimmetz committed Jan 28, 2024
1 parent c830f75 commit 16a81f9
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 6 deletions.
2 changes: 1 addition & 1 deletion config/dpkg/changelog
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@ dfdatetime (20240128-1) unstable; urgency=low

* Auto-generated

-- Log2Timeline maintainers <log2timeline-maintainers@googlegroups.com> Sun, 28 Jan 2024 09:19:21 +0100
-- Log2Timeline maintainers <log2timeline-maintainers@googlegroups.com> Sun, 28 Jan 2024 09:38:26 +0100
1 change: 1 addition & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
13 changes: 9 additions & 4 deletions tox.ini
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -25,13 +25,18 @@ commands =
coverage: coverage xml
wheel: python -m build --no-isolation --wheel

[testenv:docs]
[testenv:docformatter]
usedevelop = True
deps =
-rdocs/requirements.txt
docformatter
commands =
docformatter --in-place --recursive dfdatetime

[testenv:docs]
usedevelop = True
deps =
-rdocs/requirements.txt
commands =
sphinx-build -b html -d build/doctrees docs dist/docs
sphinx-build -b linkcheck docs dist/docs

Expand All @@ -51,6 +56,6 @@ deps =
pylint >= 2.17.0, < 2.18.0
commands =
docformatter --version
pylint --version
docformatter --check --diff --recursive dfdatetime
pylint --version
pylint --rcfile=.pylintrc dfdatetime setup.py tests
2 changes: 1 addition & 1 deletion utils/update_release.sh
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ dfdatetime (${VERSION}-1) unstable; urgency=low
EOT

# Regenerate the API documentation.
tox -edocs
tox -edocformatter,docs

exit ${EXIT_SUCCESS};

0 comments on commit 16a81f9

Please sign in to comment.