Skip to content

Commit 80de898

Browse files
authored
Merge pull request #85006 from Calinou/makerst-index-disallow-page-comments
makerst: Disallow user-contributed notes on the class index page
2 parents ad72de5 + c7f6504 commit 80de898

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

doc/tools/make_rst.py

+3-2
Original file line numberDiff line numberDiff line change
@@ -1536,8 +1536,9 @@ def make_rst_index(grouped_classes: Dict[str, List[str]], dry_run: bool, output_
15361536
else:
15371537
f = open(os.path.join(output_dir, "index.rst"), "w", encoding="utf-8")
15381538

1539-
# Remove the "Edit on Github" button from the online docs page.
1540-
f.write(":github_url: hide\n\n")
1539+
# Remove the "Edit on Github" button from the online docs page, and disallow user-contributed notes
1540+
# on the index page. User-contributed notes are allowed on individual class pages.
1541+
f.write(":github_url: hide\n:allow_comments: False\n\n")
15411542

15421543
# Warn contributors not to edit this file directly.
15431544
# Also provide links to the source files for reference.

0 commit comments

Comments
 (0)