[Python-modules-team] Bug#833791: dh_sphinxdoc: Fails to recognise Sphinx-generated documentation

[Dmitry Shachnev]

Hi Ben,

On Tue, Aug 09, 2016 at 03:15:49AM +1000, Ben Finney wrote:
> > On Tue, Aug 09, 2016 at 02:47:23AM +1000, Ben Finney wrote:
> > > $ dh_sphinxdoc doc/_build/html
> > > dh_sphinxdoc: Sphinx documentation not found at doc/_build/html/
> > 
> > This command does not make any sense. dh_sphinxdoc operates on
> > *installed* documentation
>
> As can be seen from the session in the original message, the
> documentation is installed. (It is built by the upstream build system,
> and that's the default location.)

Hm, upstream build system will not install it into the Debian package tree,
it is a task of dh_installdocs.

There is no sense calling dh_sphinxdoc before the documentation is in
debian/{packagename}/usr/share/doc/ because the symlinks created by
dh_sphinxdoc are relative and will be broken in this case.

So you should:

1) add the debian/{packagename}.docs file to get the documentation installed
by dh_sphinxdoc (you can put doc/_build/html into that file)

2) only after that call dh_sphinxdoc (probably with no arguments)

> > and looks for files in debian/{packagename}/ directories.
>
> Yes, that's why I'm specifying the location where the documentation
> was actually installed by the upstream build system.

If you specify /some/path as an argument, dh_sphinxdoc will be looking in
debian/{packagename}/some/path (for one or multiple packages).

> Its error message even reports the very directory where it looked, and
> claims it can't find documentation that evidently exists there.

I agree the error message is a bit misleading, but this is not what you
have been complaining about.

If you still have this bug after installing the documentation into the proper
directory, please give me a link to your package so that I can look at it.

-- 
Dmitry Shachnev
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 819 bytes
Desc: not available
URL: <http://lists.alioth.debian.org/pipermail/python-modules-team/attachments/20160808/81041b6d/attachment.sig>