Skip to content

Commit e8e9c38

Browse files
authored
feat(doc): add directory listings to py modules (#2658)
1 parent 5502bd8 commit e8e9c38

3 files changed

Lines changed: 16 additions & 7 deletions

File tree

pyproject.toml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,7 @@ actionlint = [
225225
"shellcheck-py>=0.10",
226226
]
227227
doc = [
228-
"docc>=0.4.0,<0.5.0",
228+
"docc>=0.5.0,<0.6.0",
229229
"fladrif>=0.2.0,<0.3.0",
230230
"mistletoe>=1.5.0,<2",
231231
]
@@ -302,6 +302,7 @@ omit = [
302302

303303
[tool.docc]
304304
context = [
305+
"docc.listing.context",
305306
"docc.references.context",
306307
"docc.search.context",
307308
"docc.html.context",
@@ -322,6 +323,7 @@ build = [
322323
"docc.resources.build",
323324
]
324325
transform = [
326+
"docc.listing.transform",
325327
"docc.python.transform",
326328
"docc.verbatim.transform",
327329
"docc.mistletoe.transform",

src/ethereum_spec_tools/docc.py

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@
4545
from docc.discover import Discover, T
4646
from docc.document import BlankNode, Document, ListNode, Node, Visit, Visitor
4747
from docc.plugins import html, mistletoe, python, verbatim
48-
from docc.plugins.listing import Listable
48+
from docc.plugins.listing import Listable, ListingNode
4949
from docc.plugins.python import PythonBuilder
5050
from docc.plugins.references import Definition, Reference
5151
from docc.settings import PluginSettings
@@ -667,6 +667,10 @@ def shallow_equals(self, lhs: Node, rhs: Node) -> bool:
667667
assert isinstance(rhs, ListNode)
668668
return True
669669

670+
elif isinstance(lhs, ListingNode):
671+
assert isinstance(rhs, ListingNode)
672+
return True
673+
670674
elif isinstance(lhs, verbatim.Transcribed):
671675
assert isinstance(rhs, verbatim.Transcribed)
672676
return True
@@ -750,6 +754,9 @@ def shallow_hash(self, node: Node) -> int:
750754
elif isinstance(node, ListNode):
751755
return hash(type(ListNode))
752756

757+
elif isinstance(node, ListingNode):
758+
return hash(type(ListingNode))
759+
753760
elif isinstance(node, verbatim.Transcribed):
754761
return hash(type(verbatim.Transcribed))
755762

uv.lock

Lines changed: 5 additions & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)