Skip to content

Commit

Permalink
Fix doc build
Browse files Browse the repository at this point in the history
  • Loading branch information
cpburnz committed Dec 9, 2023
1 parent 42bee76 commit 101e628
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 5 deletions.
10 changes: 8 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
# Updated: 2022-09-01
#

.PHONY: build create-venv help prebuild publish test test-all update-venv
.PHONY: build create-venv help prebuild publish test test-all test-doc update-venv

help:
@echo "Usage: make [<target>]"
Expand All @@ -22,6 +22,7 @@ help:
@echo " create-venv Create the development Python virtual environment."
@echo " test Run tests using the development virtual environment."
@echo " test-all Run tests using Tox for all virtual environments."
@echo " test-doc Run tests using Tox for just documentation."
@echo " update-venv Update the development Python virtual environment."

build: dist-build
Expand All @@ -36,6 +37,8 @@ test: dev-test-primary

test-all: dev-test-all

test-doc: dev-test-doc

update-venv: dev-venv-install


Expand All @@ -49,11 +52,14 @@ VENV_DIR := ./dev/venv
PYTHON := python3
VENV := ./dev/venv.sh "${VENV_DIR}"

.PHONY: dev-test-all dev-test-primary dev-venv-base dev-venv-create dev-venv-install
.PHONY: dev-test-all dev-test-doc dev-test-primary dev-venv-base dev-venv-create dev-venv-install

dev-test-all:
${VENV} tox

dev-test-doc:
${VENV} tox -e doc

dev-test-primary:
${VENV} python -m unittest -v

Expand Down
6 changes: 3 additions & 3 deletions pathspec/pathspec.py
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ def check_file(
:data:`None`) optionally contains the path separators to normalize. See
:func:`~pathspec.util.normalize_file` for more information.
Returns the file check result (:class:`CheckResult`).
Returns the file check result (:class:`~pathspec.util.CheckResult`).
"""
norm_file = normalize_file(file, separators)
include, index = self._match_file(enumerate(self.patterns), norm_file)
Expand All @@ -135,7 +135,7 @@ def check_files(
:func:`~pathspec.util.normalize_file` for more information.
Returns an :class:`~collections.abc.Iterator` yielding each file check
result (:class:`CheckResult`).
result (:class:`~pathspec.util.CheckResult`).
"""
if not _is_iterable(files):
raise TypeError(f"files:{files!r} is not an iterable.")
Expand Down Expand Up @@ -174,7 +174,7 @@ def check_tree_files(
:data:`False`.
Returns an :class:`~collections.abc.Iterator` yielding each file check
result (:class:`CheckResult`).
result (:class:`~pathspec.util.CheckResult`).
"""
files = util.iter_tree_files(root, on_error=on_error, follow_links=follow_links)
yield from self.check_files(files)
Expand Down

0 comments on commit 101e628

Please sign in to comment.