PySide Bugzilla Closed for New Bugs

PySide is now a Qt Add-on and uses the Qt Project's JIRA Bug Tracker instead of this Bugzilla instance. This Bugzilla is left for reference purposes.

Bug 895 - jQuery version is outdated, distribution code de-duplication breaks documentation search
: jQuery version is outdated, distribution code de-duplication breaks documenta...
Status: CLOSED FIXED
Product: PySide
Classification: Unclassified
Component: Documentation
: HEAD
: PC Linux
: P4 enhancement
Assigned To: Hugo Parente Lima
:
:
:
  Show dependency treegraph
 
Reported: 2011-06-23 15:58 EEST by Didier Raboud
Modified: 2011-08-23 00:35 EEST (History)
8 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Didier Raboud 2011-06-23 15:58:49 EEST
Hi, 

when testing the Debian apiextractor-doc, in which the packaging process drops
apiextractor's jquery.js (1.4.2) in favour of Debian's jquery.js (1.6.1) from
the libjs-jquery package, I noticed it breaks the search.

The most obvious fix would be to use apiextractor's jquery.js, but that's not
how we distributors work; we want to avoid code duplication.

So it would be great if PySide could migrate it's jquery.js to 1.6.1 (or to a
version compatible to it).

TIA, cheers,

OdyX
Comment 1 Hugo Parente Lima 2011-06-27 23:07:00 EEST
You are replacing parts of the project by your own, so you must also face the
consequences yourself :-).

I'm not against about update jquery.js file but I'm against spend time with
something not essential that is already working, so IMO the only way to solve
this needs to came from you, so if you provide the necessary patches to get the
search functionality working with jquery 1.6.1 we will be happy to apply them
upstream.

Well.. this is my opinion, not the PySide opinion, so I'll wait your and maybe
other comments before marking this bug as wontfix or waiting.

Regards
Comment 2 renato filho 2011-06-27 23:32:45 EEST
Discussing with hugo, and after check this "libjs-jquery" package. I discovery
that is nice thing to do on debian like dist, but this will broken windows and
other linux distribution.

Then my opinion is: During the package process you can remove our jquery.js and
apply a patch to include the correct jquery.js file, like describe on README
file on "libjs-jquery" package.

But unfortunately for now pyside documentation does not support jquery.js 1.6.
Then I think the correct thing to do now is, create a enhancement request on
pyside to support that.
Comment 3 Hugo Parente Lima 2011-06-28 00:00:56 EEST
(In reply to comment #2)
> Discussing with hugo, and after check this "libjs-jquery" package. I discovery
> that is nice thing to do on debian like dist, but this will broken windows and
> other linux distribution.
> 
> Then my opinion is: During the package process you can remove our jquery.js and
> apply a patch to include the correct jquery.js file, like describe on README
> file on "libjs-jquery" package.
> 
> But unfortunately for now pyside documentation does not support jquery.js 1.6.
> Then I think the correct thing to do now is, create a enhancement request on
> pyside to support that.

But this is already an enhancement request =].

Anyway my opinion remains the same.
Comment 4 Luciano Wolf 2011-06-28 00:13:43 EEST
As we're working with multiple archs/platforms/OSs we've to take this into
account. Breaking all the others in Debian's favor doesn't sound fair to me. As
Renato, I also see this as an enhancement that can be patched just for Debian.
I would keep it as WAITING to hear Didier's opinions again.
Comment 5 renato filho 2011-08-05 23:30:29 EEST
this feature was implemented in sphinx 1.0.8 more details on :
https://bitbucket.org/birkenfeld/sphinx/issue/682/sphinx-101-and-jquery-15-incompatibility

We will wait for this version be available on debian testing to update our
script.
Comment 6 Didier Raboud 2011-08-08 18:57:17 EEST
Hi all, 

for what is worth, I took some time to take a closer look at the documentation
generation of apiextractor. This results in the following pull request: 

https://github.com/PySide/Apiextractor/pull/5

The point of those changes is to _drop_ the huge code duplication to rely
almost entirely on python-sphinx for the documentation creation. This transfers
the responsability of having a working search and coherent documentation to
python-sphinx. As far as I can see, the layout is almost pixel-wise identical
to the current one, for a big benefit in code-lines reduction (+ it should work
across all architectures and kernels that have python-sphinx available).

What do you think ?
Comment 7 Hugo Parente Lima 2011-08-10 21:34:08 EEST
I applied your patch on all repositories (apiextractor, generatorrunner,
shiboken and pyside) plus another patch to fix the links on rel bar.

Thanks very much for the patches!

Regards.
Comment 8 renato filho 2011-08-23 00:35:29 EEST
Released on PySide 1.0.6