diff options
| -rw-r--r-- | .github/workflows/static_checks.yml | 2 | ||||
| -rw-r--r-- | doc/Makefile | 2 | ||||
| -rwxr-xr-x | doc/tools/make_rst.py (renamed from doc/tools/makerst.py) | 4 | ||||
| -rw-r--r-- | misc/hooks/README.md | 4 | ||||
| -rwxr-xr-x | misc/hooks/pre-commit | 2 | ||||
| -rwxr-xr-x | misc/hooks/pre-commit-make-rst (renamed from misc/hooks/pre-commit-makerst) | 4 |
6 files changed, 10 insertions, 8 deletions
diff --git a/.github/workflows/static_checks.yml b/.github/workflows/static_checks.yml index fd2e748076..88e5f65f22 100644 --- a/.github/workflows/static_checks.yml +++ b/.github/workflows/static_checks.yml @@ -48,4 +48,4 @@ jobs: - name: Documentation checks run: | - doc/tools/makerst.py --dry-run doc/classes modules + doc/tools/make_rst.py --dry-run doc/classes modules 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") diff --git a/misc/hooks/README.md b/misc/hooks/README.md index 5661c239ed..e420c6cb5c 100644 --- a/misc/hooks/README.md +++ b/misc/hooks/README.md @@ -12,8 +12,8 @@ contributors to make sure they comply with our requirements. `PATH`, or if you want to enable colored output with `pygmentize`. - Pre-commit hook for `black`: Applies `black` to the staged Python files before accepting a commit. -- Pre-commit hook for `makerst`: Checks the class reference syntax using - `makerst.py`. +- Pre-commit hook for `make_rst`: Checks the class reference syntax using + `make_rst.py`. ## Installation diff --git a/misc/hooks/pre-commit b/misc/hooks/pre-commit index 40cb00253b..ab0fc8176f 100755 --- a/misc/hooks/pre-commit +++ b/misc/hooks/pre-commit @@ -14,7 +14,7 @@ # as this script. Hooks should return 0 if successful and nonzero to cancel the # commit. They are executed in the order in which they are listed. #HOOKS="pre-commit-compile pre-commit-uncrustify" -HOOKS="pre-commit-clang-format pre-commit-black pre-commit-makerst" +HOOKS="pre-commit-clang-format pre-commit-black pre-commit-make-rst" ########################################################### # There should be no need to change anything below this line. diff --git a/misc/hooks/pre-commit-makerst b/misc/hooks/pre-commit-make-rst index b990788b99..38b397c494 100755 --- a/misc/hooks/pre-commit-makerst +++ b/misc/hooks/pre-commit-make-rst @@ -1,6 +1,6 @@ #!/usr/bin/env bash -# Git pre-commit hook that checks the class reference syntax using makerst.py. +# Git pre-commit hook that checks the class reference syntax using make_rst.py. # Workaround because we can't execute the .py file directly on windows PYTHON=python @@ -9,4 +9,4 @@ if [[ "$py_ver" != "3" ]]; then PYTHON+=3 fi -$PYTHON doc/tools/makerst.py doc/classes modules --dry-run +$PYTHON doc/tools/make_rst.py doc/classes modules --dry-run |