diff options
| author | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2024-12-11 16:32:56 +0100 |
|---|---|---|
| committer | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2024-12-13 15:28:55 +0100 |
| commit | 4b71168a8f23538f41b34b2d4d5ca263834853fb (patch) | |
| tree | 0d384523f677c807615c5639197d76b6bdb5ec58 /sources/pyside6/doc/developer | |
| parent | 7e622e049d19d8686d7d38a3ce0cb88f3902f69a (diff) | |
Developer documentation: Describe how to adapt generated Qt documentation to PySide
Task-number: PYSIDE-1106
Pick-to: 6.8
Change-Id: Ia13545f935dc895da069df45c5ac3fa8cdf77a9f
Reviewed-by: Ece Cinucen <ece.cinucen@qt.io>
Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
Diffstat (limited to 'sources/pyside6/doc/developer')
| -rw-r--r-- | sources/pyside6/doc/developer/add_module.rst | 8 | ||||
| -rw-r--r-- | sources/pyside6/doc/developer/documentation.rst | 2 |
2 files changed, 9 insertions, 1 deletions
diff --git a/sources/pyside6/doc/developer/add_module.rst b/sources/pyside6/doc/developer/add_module.rst index 2eb962207..2ae8702ac 100644 --- a/sources/pyside6/doc/developer/add_module.rst +++ b/sources/pyside6/doc/developer/add_module.rst @@ -58,4 +58,10 @@ Add documentation - Add entry to ``sources/pyside6/doc/modules.rst``. - Add a .qdocconf.in file in ``sources/pyside6/doc/qtmodules``. -- Add module description ``.rst`` file in ``sources/pyside6/doc/extras``. +- Add module description ``.rst`` file in ``sources/pyside6/doc/extras``: + * Run a full documentation build + * Copy the auto-generated file ``<build>/pyside6/doc/base/<Module>/index.rst`` + to ``sources/pyside6/doc/extras/<Module>/<Module>.rst`` + * Remove TOC, qmake/CMake instructions and class lists (cf existing files) + * Check the references, preferably link to converted documents + in PySide or add documents there (see :ref:`maintaining-additionaldocs`). diff --git a/sources/pyside6/doc/developer/documentation.rst b/sources/pyside6/doc/developer/documentation.rst index 65f3e7893..f768798fa 100644 --- a/sources/pyside6/doc/developer/documentation.rst +++ b/sources/pyside6/doc/developer/documentation.rst @@ -32,6 +32,8 @@ specific information like build instructions should be removed. The descriptions may link to tutorials which can be added to additionaldocs.lst for webxml extraction. +.. _maintaining-additionaldocs: + Maintaining additionaldocs.lst ------------------------------ |