Add CI check to verify MkDocs menu items (#3367)

This commit is contained in:
Gregor Hartmann 2021-01-08 23:39:47 +01:00 committed by GitHub
parent c4aaa9e0a7
commit 53fc7170bd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 26 additions and 0 deletions

View File

@ -240,3 +240,19 @@ jobs:
./tools/travis/run-luacheck-${{ matrix.os }}.sh
shell: bash
doc_check:
strategy:
fail-fast: false
runs-on: ubuntu-16.04
steps:
- uses: actions/checkout@v2
with:
submodules: false
- name: all_modules_linked
run: ./tools/check_docs_module_linkage.sh
shell: bash

View File

@ -0,0 +1,10 @@
#!/bin/bash
# get all linked module docs for mkdocs.yml
grep "modules/" mkdocs.yml | sed "s/ *- .*: *'//" | sed "s/'//" | sort > /tmp/doc
# get all module and lua_module *.md files
find docs/modules/ docs/lua-modules/ -name "*.md" | sed "sxdocs/xx" | sort > /tmp/files
diff /tmp/doc /tmp/files && echo "all *.md files are reflected in mkdocs.yml"