Groups > linux.debian.maint.python > #8825

how to build sphinx doc when there is extension

Path	csiph.com!news.mixmin.net!aioe.org!bofh.it!news.nic.it!robomod
From	PICCA Frederic-Emmanuel <frederic-emmanuel.picca@synchrotron-soleil.fr>
Newsgroups	linux.debian.maint.python
Subject	how to build sphinx doc when there is extension
Date	Tue, 30 Aug 2016 09:40:02 +0200
Message-ID	<sbLOi-1No-21@gated-at.bofh.it> (permalink)
X-Original-To	debian-python <debian-python@lists.debian.org>
X-Mailbox-Line	From debian-python-request@lists.debian.org Tue Aug 30 07:33:08 2016
Old-Return-Path	<frederic-emmanuel.picca@synchrotron-soleil.fr>
X-Amavis-Spam-Status	No, score=-0.548 tagged_above=-10000 required=5.3 tests=[BAYES_00=-2, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, FOURLA=0.1, RP_MATCHES_RCVD=-0.548, THREADTOPIC=2] autolearn=no autolearn_force=no
X-Policyd-Weight	using cached result; rate: -6.1
Dkim-Filter	OpenDKIM Filter v2.10.3 brouette.synchrotron-soleil.fr 11D3C7000E2
Dkim-Signature	v=1; a=rsa-sha256; c=relaxed/relaxed; d=synchrotron-soleil.fr; s=email; t=1472541295; bh=cpHBq75bM4VhdgQuvR5cmppX6y2vDquBRBVXEcACIjQ=; h=From:To:Subject:Date:From; b=ZRoFIjASXlHYsYjokIsh7qvrzg15JQEMCPJvFjE9KIDKziGU4N5l4mNI4Xnkz06dn C5G71IHUjEL3MOawrAMontjUhkLuYHX9GcH6uKV147zWyAAyo4+zwLR0cNS694GuR6 5i4SHIwicq3UvuMJ+XvCR2m2yhyU/dH7k47ow0XU=
Dkim-Filter	OpenDKIM Filter v2.10.3 brouette.synchrotron-soleil.fr 6151470007F
Dkim-Signature	v=1; a=rsa-sha256; c=relaxed/relaxed; d=synchrotron-soleil.fr; s=email; t=1472541294; bh=cpHBq75bM4VhdgQuvR5cmppX6y2vDquBRBVXEcACIjQ=; h=From:To:Subject:Date:From; b=Zq2gRvCaIsLQB2/wTBSHgo7zluOLe+tXKRx/UA2NkI6dVYqRmeeSmRV47fyVI1Dys 9ma2Ik4esNasgE3DE9VlY/S5aZarKDoC80+z0scm5XWApePQeVvlcu9HDCHZrGgOe+ tx/1dAmoS62A8GfJN3NvKwYZb1MXCQjeqNLGyYXM=
Thread-Topic	how to build sphinx doc when there is extension
Thread-Index	AdICjjSie4mBbJQMSH6CcC2KCwA2rA==
Accept-Language	fr-FR, en-US
Content-Language	fr-FR
X-Originating-IP	[195.221.0.171]
Content-Type	text/plain; charset="us-ascii"
Content-Transfer-Encoding	quoted-printable
MIME-Version	1.0
X-Mailing-List	<debian-python@lists.debian.org> archive/latest/14165
List-ID	<debian-python.lists.debian.org>
List-URL	<https://lists.debian.org/debian-python/>
List-Archive	https://lists.debian.org/msgid-search/A2A20EC3B8560D408356CAC2FC148E53BB2C8491@SUN-DAG3.synchrotron-soleil.fr
Approved	robomod@news.nic.it
Lines	25
Organization	linux.* mail to news gateway
Sender	robomod@news.nic.it
X-Original-Date	Tue, 30 Aug 2016 07:14:53 +0000
X-Original-Message-ID	<A2A20EC3B8560D408356CAC2FC148E53BB2C8491@SUN-DAG3.synchrotron-soleil.fr>
Xref	csiph.com linux.debian.maint.python:8825

Show key headers only | View raw

Hello

I am using this snipset when I want to build the sphinx documentation for all python available. (this is a sort of unit test).
Usually the sphinx doc use auto-doc and then it allows to check that all modules can be imported. 

override_dh_sphinxdoc:
ifeq (,$(findstring nodocs, $(DEB_BUILD_OPTIONS)))
	PYBUILD_SYSTEM=custom \
	PYBUILD_BUILD_ARGS="cd doc && PYTHONPATH={build_dir} http_proxy='127.0.0.1:9' {interpreter} -c \"import sys;from sphinx import main;sys.exit(main(sys.argv))\" -N -bhtml source build/html" dh_auto_build  # HTML generator
	dh_installdocs "doc/build/html" -p python-pyfai-doc
	dh_sphinxdoc -O--buildsystem=pybuild
endif


I would like your opinion about this and if there is better way to do this ?

thanks

Frederic

Back to linux.debian.maint.python | Previous | Next — Next in thread | Find similar | Unroll thread

Thread

how to build sphinx doc when there is extension PICCA Frederic-Emmanuel <frederic-emmanuel.picca@synchrotron-soleil.fr> - 2016-08-30 09:40 +0200
  Re: how to build sphinx doc when there is extension Piotr Ożarowski <piotr@debian.org> - 2016-08-30 10:20 +0200
    RE:how to build sphinx doc when there is extension PICCA Frederic-Emmanuel <frederic-emmanuel.picca@synchrotron-soleil.fr> - 2016-08-30 10:40 +0200
      Re: how to build sphinx doc when there is extension Ben Finney <ben+debian@benfinney.id.au> - 2016-08-30 23:10 +0200
  Re: how to build sphinx doc when there is extension Dmitry Shachnev <mitya57@debian.org> - 2016-08-31 20:10 +0200
    RE:how to build sphinx doc when there is extension PICCA Frederic-Emmanuel <frederic-emmanuel.picca@synchrotron-soleil.fr> - 2016-08-31 21:00 +0200

csiph-web