asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #85006 from Calinou/makerst-index-disallow-page-comments

Browse source 
makerst: Disallow user-contributed notes on the class index page
This commit is contained in:
Rémi Verschelde 2023-11-17 12:43:54 +01:00 committed by GitHub
commit 80de898d72
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
doc/tools/make_rst.py
View file

@ -1536,8 +1536,9 @@ def make_rst_index(grouped_classes: Dict[str, List[str]], dry_run: bool, output_
else:
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.
# Also provide links to the source files for reference.