summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorAaron Franke <arnfranke@yahoo.com>2021-10-24 01:48:03 -0500
committerAaron Franke <arnfranke@yahoo.com>2021-10-24 01:58:59 -0500
commit8f05e26198d6b8bcf620f2e87ca671bb74cf82de (patch)
tree58c5112e19d1d475bfbc6b7090ad69d375e136ad /doc
parentb2ab5cb504cef1ffe229523d63b997d5306afce3 (diff)
Rename "makerst.py" to "make_rst.py"
Diffstat (limited to 'doc')
-rw-r--r--doc/Makefile2
-rwxr-xr-xdoc/tools/make_rst.py (renamed from doc/tools/makerst.py)4
2 files changed, 4 insertions, 2 deletions
diff --git a/doc/Makefile b/doc/Makefile
index d4bc53bcf9..c46a485da1 100644
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -17,7 +17,7 @@ doxygen:
rst:
rm -rf $(OUTPUTDIR)/rst
mkdir -p $(OUTPUTDIR)/rst
- python3 $(TOOLSDIR)/makerst.py -o $(OUTPUTDIR)/rst $(CLASSES)
+ python3 $(TOOLSDIR)/make_rst.py -o $(OUTPUTDIR)/rst $(CLASSES)
rstjs:
rm -rf $(OUTPUTDIR)/rstjs
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")