diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2016-02-17 22:02:55 +0100 |
|---|---|---|
| committer | Rémi Verschelde <rverschelde@gmail.com> | 2016-02-17 22:02:55 +0100 |
| commit | e5389288dddb3b0ba33b0c0da3c33d49dc69223a (patch) | |
| tree | 152adae8a399a29657cac6ac52ea244aaff136e3 | |
| parent | 9e4532d68910873b65fef8616e7ebde180220b5c (diff) | |
Add a warning header to each rst file
To tell potential contributors that they should direct their work to the XML template and not the auto-generated reST
| -rw-r--r-- | doc/tools/makerst.py | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/tools/makerst.py b/doc/tools/makerst.py index 2ba291680d..6311be767c 100644 --- a/doc/tools/makerst.py +++ b/doc/tools/makerst.py @@ -349,6 +349,10 @@ def make_rst_class(node): 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(make_heading(name, '=')) |