Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]

Groups > linux.debian.maint.python > #12551 > unrolled thread

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

Back to article view | Back to linux.debian.maint.python

Contents

  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

#12551 — Example package using python3-pbr and Sphinx documentation with manual page

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

debian/rules has:

#!/usr/bin/make -f

%:
	dh $@ --with python3,sphinxdoc --buildsystem=pybuild

I have patched this into docs/conf.py at the end:

# -- Options for manual page output --------------------------------------------

man_pages = [
    ('usage', 'pwclient', 'VCS-agnostic tool for interacting with Patchwork',
     ['The pwclient authors (see AUTHORS file)'],
     1),
]

Any suggestions what to try next?  Thanks.

[toc] | [next] | [standalone]

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

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

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.
-- 
Jeremy Stanley

[toc] | [prev] | [next] | [standalone]

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

[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

[toc] | [prev] | [standalone]

Back to top | Article view | linux.debian.maint.python

csiph-web