[Debian-med-packaging] Bug#721780: htseq: FTBFS: dh_sphinxdoc: Sphinx documentation not found

[Andreas Tille]

Hi Diane,

On Wed, Sep 04, 2013 at 03:03:49PM -0700, Diane Trout wrote:
> I did some investigation and I think I fixed the bug.

Great.
 
> The actual problem is that dh_sphinxdoc "doesn't fail silently when there are 
> no docs". So when building a binary package, there are no html pages to 
> install which causes dh_sphinxdoc to fail. When I was making the package I 
> never tried running debuild -B so hadn't seen the problem.

I admit this check also does not belong to my standard procedure when
creating packages.  It (obviously) is detected by the autobuilders and
is a quite rare case.

> I've moved the doc building commands around a bit, so the man pages are built 
> for the binary package and the html pages are built for the -doc package.

Makes sense.

> The oddness of having a the .PHONY: clean is  because there's a file named 
> clean in the package, and without the .PHONY: declaration make thinks clean is 
> up to date and thus never runs the commands.

I was less concerned about the .PHONY declaration but rather about the clean
target.  When using dh you should rather use override_dh_clean as target.

> Also the strange http_proxy line came from 
> https://wiki.debian.org/Python/LibraryStyleGuide
> 
> Whoever wrote that wiki page recommended it to prevent silently downloading 
> dependencies from PyPI. It should currently be safe, but its hard to know if 
> in the future if upstream will add a dependency that gets automatically 
> downloaded instead of added to the build-depends.

Uhmmm, that's my fault.  If this is documented in the style guide this
is most probably tested and verified - so sorry for misleading you.  I
simply assumed that this was some local setting at your side without
checking the docs.  So I reverted my change. (git pull)

Could you please push your changes to fix the bug and reconsider the
override_dh_clean: target in favour of clean:?  The later is not really
important if things work as expected.  It is just a matter of style -
so feel free to insist on your way to do things if you like this more.

Kind regards

     Andreas.
 
> > --- a/debian/rules
> > +++ b/debian/rules
> > @@ -25,10 +25,7 @@ override_dh_installdocs:
> >         python setup.py build_sphinx -b man
> >         dh_installdocs
> > 
> > -clean:
> > +override_dh_clean:
> >         make -C src clean
> >         rm -rf dist build MANIFEST
> >         dh_clean
> > -
> > -.PHONY: clean
> > -
> 
> 

-- 
http://fam-tille.de