[Python-apps-team] Bug#952546: bootstrap.min.js in pydoctor

[Anthony Fok]

Control: tags -1 + pending

On Tue, Feb 25, 2020 at 12:06 PM Colin Watson <cjwatson at debian.org> wrote:
>
> On Tue, Feb 25, 2020 at 05:40:47PM +0000, Ian Jackson wrote:
> > (The d/copyright problem with epydoc should be easy if tedious to fix;
> > I don't understand why it wants epydoc which I thought was obsolete
> > but this is far from my field of expertise.)
>
> epydoc has been unmaintained for a long time, but the API documentation
> of various projects (notably Twisted) still relies on its docstring
> format for automatically-generated HTML documentation in a way that
> would be extremely tedious to replace with something else.  As a result,
> the approach that the Twisted developers ended up taking for pydoctor
> was to take a copy of the bits of epydoc that they needed and port those
> bits to Python 3 themselves.
>
> (This is second-hand; I'm not on the Twisted team, but I contribute a
> fair bit there and generally keep an eye on what they're doing since we
> rely on Twisted at work.)

Thank you Sean for the heads-up, and thank you Ian, Jonas and Colin
for your valuable and helpful comments.

A fix to this bug is almost ready: I have expanded d/copyright to
include the missing epydoc and bootstrap.min.css copyright info, and
added debian/missing-sources/bootstrap.css (vanilla Bootstrap v3.3.4,
equivalent to the embedded minified version, from Bootstrap CDN).

... though I discovered I foolishly uploaded an essentially empty
pydoctor binary package, and I may end up renaming it
python3-pydoctor, similar to how it was named python-pydoctor for the
Python2 version.  That's most likely why Lintian did not pick up on
the "bootstrap.min.css" missing source issue.  Jonas, thanks for
letting me know about linking to bootstrap.min.css in libjs-bootstrap;
I'll do that.

Cheers,
Anthony