Path: csiph.com!usenet.pasdenom.info!news.albasani.net!newsfeed.fsmpi.rwth-aachen.de!npeer.de.kpn-eurorings.net!npeer-ng0.de.kpn-eurorings.net!news.tele.dk!news.tele.dk!small.news.tele.dk!newsgate.cistron.nl!newsgate.news.xs4all.nl!post.news.xs4all.nl!not-for-mail Return-Path: X-Original-To: python-list@python.org Delivered-To: python-list@mail.python.org X-Spam-Status: OK 0.005 X-Spam-Evidence: '*H*': 0.99; '*S*': 0.00; 'tutorial': 0.03; 'syntax': 0.04; 'correct.': 0.07; 'subject:code': 0.07; '22,': 0.09; 'sphinx': 0.09; 'subject:test': 0.09; '.py': 0.16; 'chris,': 0.16; 'doctests': 0.16; 'exception?': 0.16; 'from:addr:rosuav': 0.16; 'from:name:chris angelico': 0.16; 'sphinx,': 0.16; 'wrote:': 0.18; 'examples': 0.20; 'import': 0.22; 'tests': 0.22; 'creating': 0.23; 'header:In-Reply-To:1': 0.27; 'testing': 0.29; 'message- id:@mail.gmail.com': 0.30; 'code': 0.31; 'sep': 0.31; 'there.': 0.32; 'programmers': 0.33; 'maybe': 0.34; 'subject:the': 0.34; "can't": 0.35; 'but': 0.35; 'received:google.com': 0.35; 'date.': 0.36; 'should': 0.36; 'to:addr:python-list': 0.38; 'pm,': 0.38; 'that,': 0.38; 'sure': 0.39; 'to:addr:python.org': 0.39; 'changed': 0.39; 'how': 0.40; "you're": 0.61; 'first': 0.61; 'believe': 0.68; 'risk': 0.72; 'novice': 0.91; 'smoke': 0.91; '2013': 0.98 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=mime-version:in-reply-to:references:date:message-id:subject:from:to :content-type; bh=di3EdqzWuE2/PLlRcJ4o0v32w81KZVmoEgDH/1Kwyhs=; b=N/Tzs6nMDFkfGr7rvwCb4yhaO+SmpNpX4FheytyBazS6bXRRyD/clB3bpr6Qqk1/q1 0kiniIExkKMJ7fs+aOHn5TbIZm2YNH5PCsTr5L9WTwv0ZQ528WYwGqUHInFmN68u8f5I lTOECON7sS+KALZnWik1nuubgCSknj90TLYB4+CboEYOFgl8hGdhrMUajC6qPKtrMT8s McMhpQaZE0kKwumI+0cBEAfeXHn60WX8uvspHpqW84bwPmmOJOy/x/WItNjRSCBk/rji vRvCAdZF5hp/jHqHYSw94J85NEwoSmguWJjIIMg8dxlzHP3iUkGRkj2i2l9fl/qBbD9f +e3w== MIME-Version: 1.0 X-Received: by 10.220.11.7 with SMTP id r7mr14867615vcr.12.1379823937012; Sat, 21 Sep 2013 21:25:37 -0700 (PDT) In-Reply-To: <5dd79e42-f1ef-4a90-b540-70f164771562@googlegroups.com> References: <6fbfa8a5-92ab-4821-92ea-7eb4efbe199d@googlegroups.com> <523d90b2$0$29988$c3e8da3$5496439d@news.astraweb.com> <9de3b59f-6cd1-4357-a59e-b2ee028d59ab@googlegroups.com> <523dbfd2$0$29988$c3e8da3$5496439d@news.astraweb.com> <0a3a0078-2d55-4cc8-bf8d-f7bede6af9f1@googlegroups.com> <5dd79e42-f1ef-4a90-b540-70f164771562@googlegroups.com> Date: Sun, 22 Sep 2013 14:25:36 +1000 Subject: Re: Sphinx Doctest: test the code without comparing the output. From: Chris Angelico To: python-list@python.org Content-Type: text/plain; charset=ISO-8859-1 X-BeenThere: python-list@python.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: General discussion list for the Python programming language List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Newsgroups: comp.lang.python Message-ID: Lines: 21 NNTP-Posting-Host: 2001:888:2000:d::a6 X-Trace: 1379823945 news.xs4all.nl 15951 [2001:888:2000:d::a6]:41634 X-Complaints-To: abuse@xs4all.nl Xref: csiph.com comp.lang.python:54575 On Sun, Sep 22, 2013 at 2:09 PM, Luca Cerone wrote: >> but if you're using this for a >> >> tutorial, you risk creating a breed of novice programmers who believe >> >> their first priority is to stop the program crashing. Smoke testing is > > Hi Chris, > actually my priority is to check that the code is correct. I changed the syntax > during the development, and I want to be sure that my tutorial is up to date. > > The user will only see the examples that, after testing with doctest, will > run. They won't know that I used doctests for the documentation.. > > How can I do what you call smoke tests in my Sphinx documentation? I don't know Sphinx, so I can't help there. But maybe you should just have a pile of .py files, and you import each one and see if you get an exception? ChrisA