asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #34097 from Calinou/travis-doc-makerst

Browse source 
Travis CI: Run `makerst.py` to check for documentation errors
This commit is contained in:
Rémi Verschelde 2019-12-04 09:05:16 +01:00 committed by GitHub
commit f0ae0a9958
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 8 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
.travis.yml
View file

@ -20,7 +20,7 @@ cache:
matrix: matrix:
include: include:
- name: Static checks (clang-format) - name: Static checks (clang-format) + Documentation checks
stage: check stage: check
env: STATIC_CHECKS=yes env: STATIC_CHECKS=yes
os: linux os: linux
@ -129,6 +129,7 @@ before_script:
script: script:
- if [ "$STATIC_CHECKS" = "yes" ]; then - if [ "$STATIC_CHECKS" = "yes" ]; then
sh ./misc/travis/clang-format.sh; sh ./misc/travis/clang-format.sh;
doc/tools/makerst.py --dry-run doc/classes modules;
else else
scons -j2 CC=$CC CXX=$CXX platform=$PLATFORM tools=$TOOLS target=$TARGET $OPTIONS $EXTRA_ARGS && scons -j2 CC=$CC CXX=$CXX platform=$PLATFORM tools=$TOOLS target=$TARGET $OPTIONS $EXTRA_ARGS &&
if [ "$TEST_PROJECT" = "yes" ]; then if [ "$TEST_PROJECT" = "yes" ]; then

6
doc/tools/makerst.py
View file

@ -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 def print_error(error, state): # type: (str, State) -> None
print(error) print("ERROR: {}".format(error))
state.errored = True 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: if c in state.classes and e in state.classes[c].enums:
return ":ref:`{0}<enum_{1}_{0}>`".format(e, c) 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) print_error("Unresolved enum '{}', file: {}".format(t, state.current_class), state)
return t return t