Skip to content

Commit 57da6dc

Browse files
authored
Merge pull request #3534 from zoldalma999/refresh-docs-on-stub-changed
Add stubs as dependencies to doc pages
2 parents 39c61e4 + 2061b11 commit 57da6dc

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

docs/reST/ext/documenters.py

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,18 @@ def get_doc(env, obj):
7474

7575

7676
class AutopgDocumenter(autoapi.documenters.AutoapiDocumenter):
77+
def __init__(self, *args, **kwargs):
78+
super().__init__(*args, **kwargs)
79+
stub_path = self.env.srcdir.parent.parent / "buildconfig" / "stubs" / "pygame"
80+
stub_file = stub_path / f"{self.env.docname.removeprefix('ref/')}.pyi"
81+
if stub_file.exists():
82+
self.env.note_dependency(stub_file.as_posix())
83+
84+
src_path = self.env.srcdir.parent.parent / "src_py"
85+
src_file = src_path / f"{self.env.docname.removeprefix('ref/')}.py"
86+
if src_file.exists():
87+
self.env.note_dependency(src_file.as_posix())
88+
7789
def format_signature(self, **kwargs):
7890
return ""
7991

0 commit comments

Comments
 (0)