Skip to content

Commit 96eef7c

Browse files
committed
ci: Ignore the installed package's egg-info in doc8
The codestyle-doc-tests job runs ``pip install -e .[test]`` before tox, which writes ``src/sagemaker_<pkg>.egg-info/SOURCES.txt`` (no trailing newline) into the tree. doc8's ignore list still named the v2 package, ``src/sagemaker_utils.egg-info``, so in all four submodules the only doc8 finding in CI was D005 on that generated file. Ignore ``src/*.egg-info`` instead.
1 parent d23ee30 commit 96eef7c

4 files changed

Lines changed: 4 additions & 4 deletions

File tree

‎sagemaker-core/tox.ini‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ ignore =
5555
require-code = True
5656

5757
[doc8]
58-
ignore-path=.tox,src/sagemaker_utils.egg-info
58+
ignore-path=.tox,src/*.egg-info
5959
# TODO: fix files before enabling max-line-length (D001)
6060
ignore=D001
6161

‎sagemaker-mlops/tox.ini‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ ignore =
5353
require-code = True
5454

5555
[doc8]
56-
ignore-path=.tox,src/sagemaker_utils.egg-info
56+
ignore-path=.tox,src/*.egg-info
5757
# TODO: fix files before enabling max-line-length (D001)
5858
ignore=D001
5959

‎sagemaker-serve/tox.ini‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ ignore =
5353
require-code = True
5454

5555
[doc8]
56-
ignore-path=.tox,src/sagemaker_utils.egg-info
56+
ignore-path=.tox,src/*.egg-info
5757
# TODO: fix files before enabling max-line-length (D001)
5858
ignore=D001
5959

‎sagemaker-train/tox.ini‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ ignore =
5353
require-code = True
5454

5555
[doc8]
56-
ignore-path=.tox,src/sagemaker_utils.egg-info
56+
ignore-path=.tox,src/*.egg-info
5757
# TODO: fix files before enabling max-line-length (D001)
5858
ignore=D001
5959

0 commit comments

Comments
 (0)