From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from localhost (localhost [127.0.0.1]) by arlo.cworth.org (Postfix) with ESMTP id 27CFC6DE1209 for ; Sun, 24 Dec 2017 05:15:03 -0800 (PST) X-Virus-Scanned: Debian amavisd-new at cworth.org X-Spam-Flag: NO X-Spam-Score: 0 X-Spam-Level: X-Spam-Status: No, score=0 tagged_above=-999 required=5 tests=[AWL=0.011, SPF_PASS=-0.001, T_RP_MATCHES_RCVD=-0.01] autolearn=disabled Received: from arlo.cworth.org ([127.0.0.1]) by localhost (arlo.cworth.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id XzYEwhtCDQnG for ; Sun, 24 Dec 2017 05:15:01 -0800 (PST) Received: from fethera.tethera.net (fethera.tethera.net [198.245.60.197]) by arlo.cworth.org (Postfix) with ESMTPS id 0DFA96DE1204 for ; Sun, 24 Dec 2017 05:15:00 -0800 (PST) Received: from remotemail by fethera.tethera.net with local (Exim 4.89) (envelope-from ) id 1eT67F-0004Ww-DL; Sun, 24 Dec 2017 08:14:57 -0500 Received: (nullmailer pid 877 invoked by uid 1000); Sun, 24 Dec 2017 13:14:56 -0000 From: David Bremner To: notmuch@notmuchmail.org Subject: [RFC] test: build python docs Date: Sun, 24 Dec 2017 09:14:52 -0400 Message-Id: <20171224131452.811-1-david@tethera.net> X-Mailer: git-send-email 2.15.1 X-BeenThere: notmuch@notmuchmail.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: "Use and development of the notmuch mail system." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sun, 24 Dec 2017 13:15:03 -0000 The idea is to consider any warning from sphinx-build as a test failure. This requires the -W option, which we probably don't want for builds. --- I'm not sure the best way to do this. An alternative approach would be to build the python docs during the main build (much as we currently build the ruby bindings). I suspect we'd want some way to disable the "-W" option to sphinx-build in that case, so that python doc failures don't break the entire build. On the other hand, for distros breaking the test suite is pretty much equivalent to breaking the build. In the proposed patch the test could be disabled by dropping sphinx-build from the test env (which makes the man pages go away), or by patching the single test out. test/T390-python.sh | 3 +++ 1 file changed, 3 insertions(+) diff --git a/test/T390-python.sh b/test/T390-python.sh index 312d61e8..63232677 100755 --- a/test/T390-python.sh +++ b/test/T390-python.sh @@ -155,4 +155,7 @@ print(list(v) == []) EOF test_expect_equal "$(cat OUTPUT)" "True" +test_begin_subtest "build python docs" +test_declare_external_prereq sphinx-build +test_expect_success "sphinx-build -n -W \"$NOTMUCH_SRCDIR\"/bindings/python/docs/source html" test_done -- 2.15.1