From e5389288dddb3b0ba33b0c0da3c33d49dc69223a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Wed, 17 Feb 2016 22:02:55 +0100 Subject: 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 --- doc/tools/makerst.py | 4 ++++ 1 file changed, 4 insertions(+) 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, '=')) -- cgit v1.2.3