diff options
| -rw-r--r-- | sources/pyside6/doc/developer/documentation.rst | 14 |
1 files changed, 12 insertions, 2 deletions
diff --git a/sources/pyside6/doc/developer/documentation.rst b/sources/pyside6/doc/developer/documentation.rst index 2d8d32fcb..65f3e7893 100644 --- a/sources/pyside6/doc/developer/documentation.rst +++ b/sources/pyside6/doc/developer/documentation.rst @@ -36,8 +36,11 @@ Maintaining additionaldocs.lst ------------------------------ The file is a list of additional documentation files. These are basically Qt -tutorials referenced by the documentation. They will receive some Python -adaption by shiboken/sphinx. +tutorials referenced by the documentation, for example "Additional Frameworks" +sections of module files. They will receive some Python adaption by +shiboken/sphinx. + +A line in brackets denotes the output directory. The list can be created by the below script and some hand-editing. It will find almost all documents. Quite a number of them might be unreferenced, but there @@ -58,6 +61,13 @@ Pages of examples that exist in Python should be removed. fi done +The overviews go into a directory named ``overviews``. There are also special +pages containing lists of classes with brief, grouped by function. They mostly +have a ``<group name="...">`` WebXML element, but may also be hand-written. +They should be referenced from the module page in a section named `List of +Classes by Function`. For clarity, the files with a ``<group>`` element are +placed into a separate directory ``groups``. + Inheritance graphs ------------------ |