Re: Automating Sphinx generated documentation

Path	csiph.com!au2pb.net!feeder.erje.net!1.eu.feeder.erje.net!newsfeed.xs4all.nl!newsfeed7.news.xs4all.nl!nzpost1.xs4all.net!not-for-mail
Return-Path	<python-python-list@m.gmane.org>
X-Original-To	python-list@python.org
Delivered-To	python-list@mail.python.org
X-Spam-Status	OK 0.001
X-Spam-Evidence	'H': 1.00; 'S': 0.00; 'sphinx': 0.07; 'docs.': 0.09; 'hooks': 0.09; 'received:80.91': 0.09; 'received:80.91.229': 0.09; 'received:gmane.org': 0.09; 'received:list': 0.09; 'python': 0.10; 'commit': 0.15; '"making': 0.16; 'received:80.91.229.3': 0.16; 'received:dip0.t-ipconnect.de': 0.16; 'received:plane.gmane.org': 0.16; 'received:t-ipconnect.de': 0.16; 'scripts.': 0.16; 'wrote:': 0.16; 'changes': 0.20; 'please?': 0.22; 'code,': 0.23; 'changes,': 0.23; 'header:User-Agent:1': 0.26; 'header:X-Complaints-To:1': 0.26; 'subject:skip:d 10': 0.27; 'this.': 0.28; 'typically': 0.29; "i'm": 0.30; 'code': 0.30; 'maybe': 0.33; 'so,': 0.35; 'to:addr:python-list': 0.36; 'subject:: ': 0.37; 'received:org': 0.37; 'integration': 0.38; 'to:addr:python.org': 0.40; 'received:de': 0.40; 'our': 0.64; 'continuous': 0.66
X-Injected-Via-Gmane	http://gmane.org/
To	python-list@python.org
From	Peter Otten <__peter__@web.de>
Subject	Re: Automating Sphinx generated documentation
Date	Fri, 18 Sep 2015 08:56:40 +0200
Organization	None
References	<41302A7145AC054FA7A96CFD03835A0A0B9D749B@EX10MBX02.EU.NEC.COM>
Mime-Version	1.0
Content-Type	text/plain; charset="ISO-8859-1"
Content-Transfer-Encoding	7Bit
X-Gmane-NNTP-Posting-Host	p57bd9c52.dip0.t-ipconnect.de
User-Agent	KNode/4.13.3
X-BeenThere	python-list@python.org
X-Mailman-Version	2.1.20+
Precedence	list
List-Id	General discussion list for the Python programming language <python-list.python.org>
List-Unsubscribe	<https://mail.python.org/mailman/options/python-list>, <mailto:python-list-request@python.org?subject=unsubscribe>
List-Archive	<http://mail.python.org/pipermail/python-list/>
List-Post	<mailto:python-list@python.org>
List-Help	<mailto:python-list-request@python.org?subject=help>
List-Subscribe	<https://mail.python.org/mailman/listinfo/python-list>, <mailto:python-list-request@python.org?subject=subscribe>
Newsgroups	comp.lang.python
Message-ID	<mailman.23.1442559418.16376.python-list@python.org> (permalink)
Lines	19
NNTP-Posting-Host	2001:888:2000:d::a6
X-Trace	1442559418 news.xs4all.nl 23779 [2001:888:2000:d::a6]:52951
X-Complaints-To	abuse@xs4all.nl
Xref	csiph.com comp.lang.python:96804

Show key headers only | View raw

David Aldrich wrote:

> I have setup Sphinx for my Python project. We keep all our code and
> documentation in Subversion. So, following changes to the Python code, I
> need to regenerate and commit the Sphinx generated documentation.
> 
> I just wondered how people manage this.  I'm thinking of using Jenkins (a
> continuous integration tool) to check for changes, regenerate the docs and
> check them in.
> 
> Any suggestions please?

VCS typically have a few hooks to trigger scripts. I found

"Making the Most of Commit Hooks with Subversion"
http://www.linux-mag.com/id/7151/

Maybe you can use one of these to trigger a rebuilt of the  docs.

Back to comp.lang.python | Previous | Next | Find similar | Unroll thread

Thread

Re: Automating Sphinx generated documentation Peter Otten <__peter__@web.de> - 2015-09-18 08:56 +0200

csiph-web