diff options
author | Cristián Maureira-Fredes <Cristian.Maureira-Fredes@qt.io> | 2022-04-06 13:00:38 +0200 |
---|---|---|
committer | Cristián Maureira-Fredes <Cristian.Maureira-Fredes@qt.io> | 2022-04-08 15:32:58 +0200 |
commit | 12794ff54b434ed3f06988ca8fe12bce28c63155 (patch) | |
tree | 9a160e32eb30a4828b70dc6036ece0e8bbfc58ce | |
parent | af7ec7bef57b02a88a459869865eb197f2ed5a1a (diff) |
doc: use sphinx panels for the offline doc
Removing the special case where a HTML table
was generated instead of the sphinx-panels.
Change-Id: Ic2fe6276cf63ca559c14d9309c2e7cbd3515f2c3
Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
-rw-r--r-- | sources/pyside6/doc/index.rst | 179 | ||||
-rw-r--r-- | sources/shiboken6/doc/index.rst | 112 |
2 files changed, 120 insertions, 171 deletions
diff --git a/sources/pyside6/doc/index.rst b/sources/pyside6/doc/index.rst index 53dd3de38..10b878d9b 100644 --- a/sources/pyside6/doc/index.rst +++ b/sources/pyside6/doc/index.rst @@ -36,140 +36,111 @@ This project is available under the LGPLv3/GPLv3 and the `Qt commercial license` Documentation ============= -.. ifconfig:: output_format == 'html' - - .. panels:: - :body: align-items-center jutify-content-center text-center - :container: container-lg pb-3 - :column: col-lg-4 col-md-4 col-sm-6 col-xs-12 p-2 - :img-top-cls: d-flex align-self-center img-responsive card-img-top-main - - :img-top: images/Desktop.svg +.. panels:: + :body: align-items-center jutify-content-center text-center + :container: container-lg pb-3 + :column: col-lg-4 col-md-4 col-sm-6 col-xs-12 p-2 + :img-top-cls: d-flex align-self-center img-responsive card-img-top-main - Write your first Qt application. + :img-top: images/Desktop.svg - +++ + Write your first Qt application. - .. link-button:: quickstart - :type: ref - :text: Check it out! - :classes: btn-qt btn-block stretched-link - --- - :img-top: images/Support.svg + +++ - Install and build from source. + .. link-button:: quickstart + :type: ref + :text: Check it out! + :classes: btn-qt btn-block stretched-link + --- + :img-top: images/Support.svg - +++ + Install and build from source. - .. link-button:: gettingstarted - :type: ref - :text: Getting Started - :classes: btn-qt btn-block stretched-link - --- - :img-top: images/Dev.svg + +++ - PySide API reference. + .. link-button:: gettingstarted + :type: ref + :text: Getting Started + :classes: btn-qt btn-block stretched-link + --- + :img-top: images/Dev.svg - +++ + PySide API reference. - .. link-button:: api - :type: ref - :text: API Docs - :classes: btn-qt btn-block stretched-link + +++ - --- - :img-top: images/Tutorials.svg + .. link-button:: api + :type: ref + :text: API Docs + :classes: btn-qt btn-block stretched-link - Learn with step-by-step guides. + --- + :img-top: images/Tutorials.svg - +++ + Learn with step-by-step guides. - .. link-button:: tutorials/index - :type: ref - :text: Tutorials - :classes: btn-qt btn-block stretched-link - --- - :img-top: images/Examples.svg + +++ - Check all the available examples. + .. link-button:: tutorials/index + :type: ref + :text: Tutorials + :classes: btn-qt btn-block stretched-link + --- + :img-top: images/Examples.svg - +++ + Check all the available examples. - .. link-button:: examples/index - :type: ref - :text: Examples - :classes: btn-qt btn-block stretched-link - --- - :img-top: images/Training.svg + +++ - Watch webinars, talks, and more. + .. link-button:: examples/index + :type: ref + :text: Examples + :classes: btn-qt btn-block stretched-link + --- + :img-top: images/Training.svg - +++ + Watch webinars, talks, and more. - .. link-button:: videos - :type: ref - :text: Videos - :classes: btn-qt btn-block stretched-link + +++ - --- - :img-top: images/Deployment.svg + .. link-button:: videos + :type: ref + :text: Videos + :classes: btn-qt btn-block stretched-link - Learn to deploy your applications. + --- + :img-top: images/Deployment.svg - +++ + Learn to deploy your applications. - .. link-button:: deployment-guides - :type: ref - :text: Deployment - :classes: btn-qt btn-block stretched-link - --- - :img-top: images/stopwatch.svg + +++ - API differences and known issues. + .. link-button:: deployment-guides + :type: ref + :text: Deployment + :classes: btn-qt btn-block stretched-link + --- + :img-top: images/stopwatch.svg - +++ + API differences and known issues. - .. link-button:: considerations - :type: ref - :text: Considerations - :classes: btn-qt btn-block stretched-link - --- - :img-top: images/cpp_python.svg + +++ - Generate C++ to Python bindings. + .. link-button:: considerations + :type: ref + :text: Considerations + :classes: btn-qt btn-block stretched-link + --- + :img-top: images/cpp_python.svg - +++ + Generate C++ to Python bindings. - .. link-button:: shiboken6/index.html - :text: Shiboken - :classes: btn-qt btn-block stretched-link - -.. ifconfig:: output_format == 'qthelp' + +++ - .. raw:: html - - <table class="special"> - <colgroup> - <col style="width: 33%" /> - <col style="width: 33%" /> - <col style="width: 33%" /> - </colgroup> - <tr> - <td><a href="quickstart.html"><p><strong>Check It Out!</strong><br/>Write your first Qt app.</p></a></td> - <td><a href="gettingstarted.html"><p><strong>Getting Started</strong><br/>Install and build from source.</p></a></td> - <td><a href="api.html"><p><strong>API Docs</strong><br/>Qt for Python API reference.</p></a></td> - </tr> - <tr> - <td><a href="tutorials/index.html"><p><strong>Tutorials</strong><br/>Learn with step-by-step guides.</p></a></td> - <td><a href="examples/index.html"><p><strong>Examples</strong><br/>Check all the available examples.</p></a></td> - <td><a href="videos.html"><p><strong>Videos</strong><br/>Watch webinars, Talks, and more.</p></a></td> - </tr> - <tr> - <td><a href="deployment.html" style="display: block;"><p><strong>Deployment</strong><br/>Learn to deploy your apps.</p></a></td> - <td><a href="considerations.html" style="display: block;"><p><strong>Considerations</strong><br/>API differences and known issues.</p></a></td> - <td><a href="../shiboken6/index.html" style="display: block;"><p><strong>Shiboken</strong><br/>Generate C++ to Python binding.</p></a></td> - </tr> - </table> + .. link-button:: shiboken6/index.html + :text: Shiboken + :classes: btn-qt btn-block stretched-link We have also a `wiki page`_ where you can find how to report bugs, contribute or contact the community. diff --git a/sources/shiboken6/doc/index.rst b/sources/shiboken6/doc/index.rst index 87d39113d..d7cb4c2b1 100644 --- a/sources/shiboken6/doc/index.rst +++ b/sources/shiboken6/doc/index.rst @@ -25,95 +25,73 @@ Shiboken Documentation ============= -.. ifconfig:: output_format == 'html' - - .. panels:: - :body: text-center - :container: container-lg pb-3 - :column: col-lg-4 col-md-4 col-sm-6 col-xs-12 p-2 +.. panels:: + :body: text-center + :container: container-lg pb-3 + :column: col-lg-4 col-md-4 col-sm-6 col-xs-12 p-2 - Install and build from source. + Install and build from source. - +++ + +++ - .. link-button:: gettingstarted - :type: ref - :text: Getting Started - :classes: btn-qt btn-block stretched-link - --- + .. link-button:: gettingstarted + :type: ref + :text: Getting Started + :classes: btn-qt btn-block stretched-link + --- - Binding generator executable. + Binding generator executable. - +++ + +++ - .. link-button:: shibokengenerator - :type: ref - :text: Shiboken Generator - :classes: btn-qt btn-block stretched-link - --- + .. link-button:: shibokengenerator + :type: ref + :text: Shiboken Generator + :classes: btn-qt btn-block stretched-link + --- - Python utility module. + Python utility module. - +++ + +++ - .. link-button:: shibokenmodule - :type: ref - :text: Shiboken Module - :classes: btn-qt btn-block stretched-link + .. link-button:: shibokenmodule + :type: ref + :text: Shiboken Module + :classes: btn-qt btn-block stretched-link - --- + --- - Reference and functionallities. + Reference and functionallities. - +++ + +++ - .. link-button:: typesystem - :type: ref - :text: Type System - :classes: btn-qt btn-block stretched-link + .. link-button:: typesystem + :type: ref + :text: Type System + :classes: btn-qt btn-block stretched-link - --- + --- - Using Shiboken. + Using Shiboken. - +++ + +++ - .. link-button:: examples/index - :type: ref - :text: Examples - :classes: btn-qt btn-block stretched-link + .. link-button:: examples/index + :type: ref + :text: Examples + :classes: btn-qt btn-block stretched-link - --- + --- - Known issues and FAQ. + Known issues and FAQ. - +++ + +++ - .. link-button:: considerations - :type: ref - :text: Considerations - :classes: btn-qt btn-block stretched-link - -.. ifconfig:: output_format == 'qthelp' + .. link-button:: considerations + :type: ref + :text: Considerations + :classes: btn-qt btn-block stretched-link - <table class="special"> - <colgroup> - <col style="width: 33%" /> - <col style="width: 33%" /> - <col style="width: 33%" /> - </colgroup> - <tr> - <td><a href="gettingstarted.html"><p><strong>Getting Started</strong><br/>Install and build from source.</p></a></td> - <td><a href="shibokengenerator.html"><p><strong>Shiboken Generator</strong><br/>Binding generator executable.</p></a></td> - <td><a href="shibokenmodule.html"><p><strong>Shiboken Module</strong><br/>Python utility module.</p></a></td> - </tr> - <tr> - <td><a href="typesystem.html"><p><strong>Type System</strong><br/>Reference and functionality.</p></a></td> - <td><a href="examples/index.html"><p><strong>Examples</strong><br/>Using Shiboken.</p></a></td> - <td><a href="considerations.html"><p><strong>Considerations</strong><br/>Known issues and FAQ.</p></a></td> - </tr> - - </table> .. toctree:: :hidden: |