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

Re: Example package using python3-pbr and Sphinx documentation with manual page

Path	csiph.com!aioe.org!bofh.it!news.nic.it!robomod
From	Jeremy Stanley <fungi@yuggoth.org>
Newsgroups	linux.debian.maint.python
Subject	Re: Example package using python3-pbr and Sphinx documentation with manual page
Date	Mon, 04 May 2020 21:20:02 +0200
Message-ID	<A2ONc-70p-3@gated-at.bofh.it> (permalink)
References	<A2MV3-5TB-5@gated-at.bofh.it> <A2ODv-6Xa-3@gated-at.bofh.it>
X-Mailbox-Line	From debian-python-request@lists.debian.org Mon May 4 19:18:28 2020
Old-Return-Path	<fungi@yuggoth.org>
X-Amavis-Spam-Status	No, score=-12 tagged_above=-10000 required=5.3 tests=[BAYES_00=-2, DIGITS_LETTERS=1, LDO_WHITELIST=-5, MD5_SHA1_SUM=-1, PGPSIGNATURE=-5] autolearn=ham autolearn_force=no
X-Policyd-Weight	using cached result; rate: -4.6
MIME-Version	1.0
Content-Type	multipart/signed; micalg=pgp-sha512; protocol="application/pgp-signature"; boundary="jqkmtzrbkj3ajhpl"
Content-Disposition	inline
User-Agent	NeoMutt/20170113 (1.7.2)
X-Sa-Exim-Connect-IP	2001:4802:7801:102:be76:4eff:fe20:63e0
X-Sa-Exim-Rcpt-To	debian-python@lists.debian.org
X-Sa-Exim-Mail-From	fungi@yuggoth.org
X-Sa-Exim-Scanned	No (on azathoth.yuggoth.org); SAEximRunCond expanded to false
X-Mailing-List	<debian-python@lists.debian.org> archive/latest/18238
List-ID	<debian-python.lists.debian.org>
List-URL	<https://lists.debian.org/debian-python/>
List-Archive	https://lists.debian.org/msgid-search/20200504191810.lmrrjxg5cy5j5qcw@yuggoth.org
Approved	robomod@news.nic.it
Lines	59
Organization	linux.* mail to news gateway
Sender	robomod@news.nic.it
X-Original-Date	Mon, 4 May 2020 19:18:10 +0000
X-Original-Message-ID	<20200504191810.lmrrjxg5cy5j5qcw@yuggoth.org>
X-Original-References	<87368fvd19.fsf@mid.deneb.enyo.de> <20200504190659.z5ap62demjih34ye@yuggoth.org>
Xref	csiph.com linux.debian.maint.python:12553

Show key headers only | View raw

[Multipart message — attachments visible in raw view] - view raw

On 2020-05-04 19:07:00 +0000 (+0000), Jeremy Stanley wrote:
> On 2020-05-04 19:13:38 +0200 (+0200), Florian Weimer wrote:
> > I'm trying to package pwclient, which depends on python3-pbr and has a
> > rudimentary manual page generated from Sphinx documentation.  Is there
> > a similar example package which I can look at, to see how to trigger
> > the manual page generation?
> > 
> > I currently get this:
> > 
> > dh_sphinxdoc: warning: Sphinx documentation not found
> [...]
> 
> Since PBR originated in OpenStack, the python3-openstackclient
> package may serve as a good example. It does a dh_sphinxdoc override
> for manpage building here:
> 
> <URL: https://salsa.debian.org/openstack-team/clients/python-openstackclient/-/blob/88bdecc66a30b4e3d5aec9cdae4cc529c33690e6/debian/rules#L27 >
> 
> Then there's a similar dh_installman override a few lines later.

Oh, and since you mentioned the conf.py contents, here's how it's
being done in the upstream source for that repo:

<URL: https://opendev.org/openstack/python-openstackclient/src/commit/fdefe5558b7237757d788ee000382f913772bffc/doc/source/conf.py#L225-L233 >

-- 
Jeremy Stanley

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

Thread

Example package using python3-pbr and Sphinx documentation with manual page Florian Weimer <fw@deneb.enyo.de> - 2020-05-04 19:20 +0200
  Re: Example package using python3-pbr and Sphinx documentation with  manual page Jeremy Stanley <fungi@yuggoth.org> - 2020-05-04 21:10 +0200
    Re: Example package using python3-pbr and Sphinx documentation with  manual page Jeremy Stanley <fungi@yuggoth.org> - 2020-05-04 21:20 +0200

csiph-web