diff options
| author | Rémi Verschelde <remi@verschelde.fr> | 2021-10-26 08:43:07 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-10-26 08:43:07 +0200 |
| commit | 2ecab0491cb9fc65cf71a0231e57915441e7048a (patch) | |
| tree | c09d88c95f21faae8f0923775e0767b401dde8bf /doc/tools | |
| parent | ba23ef9b292dc42051ee8d11fa1fe6818b018c8f (diff) | |
| parent | 8f05e26198d6b8bcf620f2e87ca671bb74cf82de (diff) | |
Merge pull request #54179 from aaronfranke/make-rst
Diffstat (limited to 'doc/tools')
| -rwxr-xr-x | doc/tools/make_rst.py (renamed from doc/tools/makerst.py) | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/doc/tools/makerst.py b/doc/tools/make_rst.py index 1ec9627c2c..ad9e5f4897 100755 --- a/doc/tools/makerst.py +++ b/doc/tools/make_rst.py @@ -1,5 +1,7 @@ #!/usr/bin/env python3 +# This script makes RST files from the XML class reference for use with the online docs. + import argparse import os import re @@ -399,7 +401,7 @@ def make_rst_class(class_def, state, dry_run, output_dir): # type: (ClassDef, S # Warn contributors not to edit this file directly f.write(":github_url: hide\n\n") - f.write(".. Generated automatically by doc/tools/makerst.py in Godot's source tree.\n") + f.write(".. Generated automatically by doc/tools/make_rst.py in Godot's source tree.\n") f.write(".. DO NOT EDIT THIS FILE, but the " + class_name + ".xml source instead.\n") f.write(".. The source is found in doc/classes or modules/<name>/doc_classes.\n\n") |