Add script to check for doc changes

This commit is contained in:
Florian Bruhin 2016-03-15 22:43:47 +01:00
parent 5ae9f0405d
commit 07d31634c6
2 changed files with 36 additions and 1 deletions

View File

@ -0,0 +1,35 @@
#!/usr/bin/env python3
# vim: ft=python fileencoding=utf-8 sts=4 sw=4 et:
# Copyright 2016 Florian Bruhin (The Compiler) <mail@qutebrowser.org>
# This file is part of qutebrowser.
#
# qutebrowser is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# qutebrowser is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with qutebrowser. If not, see <http://www.gnu.org/licenses/>.
"""Check if docs changed and output an error if so."""
import sys
import subprocess
code = subprocess.call(['git', '--no-pager', 'diff', '--exit-code', '--stat'])
if code != 0:
print()
print('The autogenerated docs changed, please run this to update them:')
print(' tox -e docs')
print(' git commit -am "Update docs"')
print()
print('(Or you have uncommited changes, in which case you can ignore '
'this.)')
sys.exit(code)

View File

@ -203,7 +203,7 @@ deps =
commands =
{envpython} scripts/link_pyqt.py --tox {envdir}
{envpython} scripts/dev/src2asciidoc.py
git --no-pager diff --exit-code --stat
{envpython} scripts/dev/check_doc_changes.py
{envpython} scripts/asciidoc2html.py {posargs}
[testenv:cxfreeze-windows]