godotengine/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2025-11-13 13:31:48 +00:00
Code Releases Wiki Activity

Add a warning header to each rst file

Browse Source 
To tell potential contributors that they should direct their work to the XML template and not the auto-generated reST
This commit is contained in:
Rémi Verschelde
2016-02-17 22:02:55 +01:00
parent 9e4532d689
commit e5389288dd
1 changed files with 4 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
doc/tools/makerst.py
View File

@@ -349,6 +349,10 @@ def make_rst_class(node):
f = open("class_"+name.lower() + '.rst', 'wb') f = open("class_"+name.lower() + '.rst', 'wb')
# Warn contributors not to edit this file directly
f.write(".. Generated automatically by doc/tools/makerst.py in Godot's source tree.\n")
f.write(".. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.\n\n")
f.write(".. _class_"+name+":\n\n") f.write(".. _class_"+name+":\n\n")
f.write(make_heading(name, '=')) f.write(make_heading(name, '='))