Przeglądaj źródła

makerst: Disallow user-contributed notes on the class index page

User-contributed notes are still allowed on individual class pages.
Hugo Locurcio 1 rok temu
rodzic
commit
c7f6504105
1 zmienionych plików z 3 dodań i 2 usunięć
  1. 3 2
      doc/tools/make_rst.py

+ 3 - 2
doc/tools/make_rst.py

@@ -1536,8 +1536,9 @@ def make_rst_index(grouped_classes: Dict[str, List[str]], dry_run: bool, output_
     else:
     else:
         f = open(os.path.join(output_dir, "index.rst"), "w", encoding="utf-8")
         f = open(os.path.join(output_dir, "index.rst"), "w", encoding="utf-8")
 
 
-    # Remove the "Edit on Github" button from the online docs page.
-    f.write(":github_url: hide\n\n")
+    # Remove the "Edit on Github" button from the online docs page, and disallow user-contributed notes
+    # on the index page. User-contributed notes are allowed on individual class pages.
+    f.write(":github_url: hide\n:allow_comments: False\n\n")
 
 
     # Warn contributors not to edit this file directly.
     # Warn contributors not to edit this file directly.
     # Also provide links to the source files for reference.
     # Also provide links to the source files for reference.