[PyQt] Documentation Style (Was: PyQt4 feature request)

[Antonio Valentino]

Il giorno Sun, 8 Mar 2009 12:04:51 +0100
Detlev Offenbach <detlev at die-offenbachs.de> ha scritto:

> On Sonntag, 8. März 2009, Antonio Valentino wrote:
> > Il giorno Sun, 8 Mar 2009 10:40:38 +0100
> >
> > Detlev Offenbach <detlev at die-offenbachs.de> ha scritto:
> > > Hi,
> > >
> > > I think the Sphinx style should be prefered. As far as I know
> > > (please confirm) Sphinx has the capability to generate Qt Help
> > > files (*.qch) as well. If that is true, one could satisfy both
> > > parties.
> > >
> > > Regards,
> > > Detlev
> >
> > Detlev,
> > as far as I know QtAssistant don't fully support style-sheets
> > bundled with Sphinx (please correct me if I'm wrong) so results you
> > can achieve running sphinx out of the box to produce Qt docs are
> > very poor.
> 
> Since Qt4.4 QtAssistant uses webkit based widgets. Eric uses these
> widgets as well and it will support QtHelp starting with the first
> 4.4 snapshot.

Great!

.. but, just a question, what described in 

http://doc.trolltech.com/4.4/richtext-html-subset.html

applies or not to QtAssistant?
If not that means I have a completely wrong understanding of the
problem.

> > I provided the initial patch but still haven't had the time to
> > complete the job (also because I'm not to much familiar with HTML
> > CSS ad such).
> >
> > I also have to point out that the qthelp builder is only available
> > in the development version (presumably it will be included in
> > Sphinx 0.6).
> >
> > In my opinion there is not too much work to do (a custom style-sheet
> > and some tweaks on the template) but if you expect all works out of
> > the box you will get disappointed.
> 
> Isn't this occasion reason enough to complete the work?

Yes, I'll do my best.

It would help a lot if you (an all interested readers) could
try to

$ hg clone http://bitbucket.org/birkenfeld/sphinx/
$ cd sphinx/doc
$ make qthelp
$ qcollectiongenerator _build/qthelp/Sphinx.qhcp
$ assistant -collectionFile _build/qthelp/Sphinx.qhc

and tell me what you think about.

thanks

-- 
Antonio Valentino