Skip to content

add hook for customizing listing sources #45

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
SamWilsn merged 1 commit into from
Apr 25, 2026
Merged

add hook for customizing listing sources #45

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/docc/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,5 +17,5 @@
The documentation compiler.
"""

__version__ = "0.5.0"
__version__ = "0.5.1"
"Current version of docc"
7 changes: 6 additions & 1 deletion src/docc/plugins/listing/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,11 @@ class ListingDiscover(Discover):
def __init__(self, config: PluginSettings) -> None:
pass

def _listing_source(
self, source: Source, parent: PurePath
) -> "ListingSource":
return ListingSource(parent, parent / "index", set())

def discover(self, known: FrozenSet[T]) -> Iterator["ListingSource"]:
"""
Find sources.
Expand All @@ -129,7 +134,7 @@ def discover(self, known: FrozenSet[T]) -> Iterator["ListingSource"]:
try:
listing = listings[parent]
except KeyError:
listing = ListingSource(parent, parent / "index", set())
listing = self._listing_source(source, parent)
listings[parent] = listing
yield listing

Expand Down
Loading