Merge pull request #54179 from aaronfranke/make-rst

This commit is contained in:
Rémi Verschelde 2021-10-26 08:43:07 +02:00 committed by GitHub
commit 2ecab0491c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 10 additions and 8 deletions

View File

@ -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

View File

@ -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

View File

@ -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")

View File

@ -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

View File

@ -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.

View File

@ -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