From 07d31634c69686abb5c5055ca9b6ec2ddc92e68c Mon Sep 17 00:00:00 2001 From: Florian Bruhin Date: Tue, 15 Mar 2016 22:43:47 +0100 Subject: [PATCH] Add script to check for doc changes --- scripts/dev/check_doc_changes.py | 35 ++++++++++++++++++++++++++++++++ tox.ini | 2 +- 2 files changed, 36 insertions(+), 1 deletion(-) create mode 100755 scripts/dev/check_doc_changes.py diff --git a/scripts/dev/check_doc_changes.py b/scripts/dev/check_doc_changes.py new file mode 100755 index 000000000..6e99f94a7 --- /dev/null +++ b/scripts/dev/check_doc_changes.py @@ -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) + +# 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 . + +"""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) diff --git a/tox.ini b/tox.ini index 7f38f14a4..8aff26f7f 100644 --- a/tox.ini +++ b/tox.ini @@ -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]