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

Giovanni Bajo rasky at develer.com
Mon Mar 9 11:28:45 GMT 2009


On 3/7/2009 6:50 PM, Phil Thompson wrote:
> On Sat, 7 Mar 2009 18:06:12 +0100, Detlev Offenbach
> <detlev at die-offenbachs.de> wrote:
>> Hi,
>>
>> please include the PyQt4 documentation as a compressed Qt Help files
>> (*.qch) 
>> as well. eric4 will support Qt Help collections starting with the first
> 4.4
>> snapshot.
> 
> An opportune moment to ask for opinions...
> 
> When I (eventually) get round to improving the PyQt docs (particularly
> making the API reference more Pythonic) it will be designed to support (in
> theory) multiple output styles. In the Roadmap I specifically mention the
> traditional Qt style and Sphinx (ie. that used for the Python v2.6
> documentation).
> 
> Which of these two styles do people prefer?

As long as I can open it in the Qt Assistant, it does not matter. Qt 
Assistant is several order of magnitudes faster than using Firefox, for 
browsing documentation. It's unvaluable, for instance, to start typing 
"setLab" and see all the matches in realtime and quickly find the 
correct method within whatever class it happens to be inside.
-- 
Giovanni Bajo
Develer S.r.l.
http://www.develer.com


More information about the PyQt mailing list