[PyQt] Updated PyQt Documents - Feedback Please

Neil Jansen neil.jansen at rockwellcollins.com
Fri Sep 28 16:47:19 BST 2018

I think it's a great improvement over what was there before.

My first criticism is that it's a bit confusing to get to the important
part (the actual API documentation, which has been what a lot of people
here were asking for), it's hidden in the lower right-hand corner ("Modules
| Classes | Index").  Why not add these to the bulleted list, towards the

Second, would it be possible to add a link from each PyQt5 class API page,
to the official Qt5 API page?

On Fri, Sep 28, 2018 at 11:39 AM Phil Thompson <phil at riverbankcomputing.com>

> I've made a new release of the PyQt documentation at...
> https://pyqt.readthedocs.io
> This is the first stage of creating complete PyQt5 documentation (similar
> to what was done with the PyQt4 documentation).
> The documentation is created from 4 sources:
> - "static" text files
> - .sip files that provide the objects (modules, classes, enums etc) being
> documented with hooks
>   for "description files"
> - the Qt source code which provide the initial content of the description
> files
> - the description files which will be updated over time (a long time!) to
> become more Pythonic
>   as required.
> The system is designed so that it can be updated with new PyQt and Qt
> releases without losing any user-written changes to the description files.
> For the moment the description files are just stubs (lots of TODOs)
> because I wanted feedback on the overall structure before populating it
> from the Qt documentation.
> There are lots of outstanding issues that will be addressed over time. For
> example, nested classes are only referenced from the class index (mainly an
> issue for the classes that implement enum flags).
> Any feedback and suggestions for improvement are welcome.
> Phil
> _______________________________________________
> PyQt mailing list    PyQt at riverbankcomputing.com
> https://www.riverbankcomputing.com/mailman/listinfo/pyqt
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://www.riverbankcomputing.com/pipermail/pyqt/attachments/20180928/021d0fc0/attachment.html>

More information about the PyQt mailing list