Merge pull request #34097 from Calinou/travis-doc-makerst
Travis CI: Run `makerst.py` to check for documentation errors
This commit is contained in:
commit
f0ae0a9958
2 changed files with 8 additions and 3 deletions
|
@ -20,7 +20,7 @@ cache:
|
|||
|
||||
matrix:
|
||||
include:
|
||||
- name: Static checks (clang-format)
|
||||
- name: Static checks (clang-format) + Documentation checks
|
||||
stage: check
|
||||
env: STATIC_CHECKS=yes
|
||||
os: linux
|
||||
|
@ -129,6 +129,7 @@ before_script:
|
|||
script:
|
||||
- if [ "$STATIC_CHECKS" = "yes" ]; then
|
||||
sh ./misc/travis/clang-format.sh;
|
||||
doc/tools/makerst.py --dry-run doc/classes modules;
|
||||
else
|
||||
scons -j2 CC=$CC CXX=$CXX platform=$PLATFORM tools=$TOOLS target=$TARGET $OPTIONS $EXTRA_ARGS &&
|
||||
if [ "$TEST_PROJECT" = "yes" ]; then
|
||||
|
|
|
@ -14,7 +14,7 @@ GODOT_DOCS_PATTERN = re.compile(r'^http(?:s)?://docs\.godotengine\.org/(?:[a-zA-
|
|||
|
||||
|
||||
def print_error(error, state): # type: (str, State) -> None
|
||||
print(error)
|
||||
print("ERROR: {}".format(error))
|
||||
state.errored = True
|
||||
|
||||
|
||||
|
@ -982,7 +982,11 @@ def make_enum(t, state): # type: (str, State) -> str
|
|||
|
||||
if c in state.classes and e in state.classes[c].enums:
|
||||
return ":ref:`{0}<enum_{1}_{0}>`".format(e, c)
|
||||
|
||||
# Don't fail for `Vector3.Axis`, as this enum is a special case which is expected not to be resolved.
|
||||
if "{}.{}".format(c, e) != "Vector3.Axis":
|
||||
print_error("Unresolved enum '{}', file: {}".format(t, state.current_class), state)
|
||||
|
||||
return t
|
||||
|
||||
|
||||
|
|
Loading…
Reference in a new issue