diff options
16 files changed, 37 insertions, 1 deletions
diff --git a/examples/bluetooth/heartrate_game/doc/heartrate_game.rst b/examples/bluetooth/heartrate_game/doc/heartrate_game.rst index 0a0938cad..9d190d991 100644 --- a/examples/bluetooth/heartrate_game/doc/heartrate_game.rst +++ b/examples/bluetooth/heartrate_game/doc/heartrate_game.rst @@ -1,6 +1,8 @@ Bluetooth Low Energy Heart Rate Game ==================================== +.. tags:: Android + The Bluetooth Low Energy Heart Rate Game shows how to develop a Bluetooth Low Energy application using the Qt Bluetooth API. The application covers the scanning for Bluetooth Low Energy devices, diff --git a/examples/bluetooth/lowenergyscanner/doc/lowenergyscanner.rst b/examples/bluetooth/lowenergyscanner/doc/lowenergyscanner.rst index c20c2d8b7..a0c574350 100644 --- a/examples/bluetooth/lowenergyscanner/doc/lowenergyscanner.rst +++ b/examples/bluetooth/lowenergyscanner/doc/lowenergyscanner.rst @@ -1,6 +1,8 @@ Bluetooth Low Energy Scanner Example ==================================== +.. tags:: Android + A Python application that demonstrates the analogous example in Qt `Bluetooth Low Energy Scanner <https://doc.qt.io/qt-6/qtbluetooth-lowenergyscanner-example.html>`_ diff --git a/examples/location/mapviewer/doc/mapviewer.rst b/examples/location/mapviewer/doc/mapviewer.rst index d30544991..418e2e77e 100644 --- a/examples/location/mapviewer/doc/mapviewer.rst +++ b/examples/location/mapviewer/doc/mapviewer.rst @@ -1,6 +1,8 @@ Map Viewer Example ================== +.. tags:: Android + The Map Viewer example shows how to display and interact with a map, search for an address, and find driving directions. diff --git a/examples/multimedia/audiooutput/doc/audiooutput.rst b/examples/multimedia/audiooutput/doc/audiooutput.rst index bbd71c5d8..fac7e33e1 100644 --- a/examples/multimedia/audiooutput/doc/audiooutput.rst +++ b/examples/multimedia/audiooutput/doc/audiooutput.rst @@ -1,6 +1,8 @@ Audio Output Example ==================== +.. tags:: Android + Audio Output demonstrates the basic use cases of QAudioOutput. This example provides a tone generator to supply continuous audio playback. The diff --git a/examples/multimedia/audiosource/doc/audiosource.rst b/examples/multimedia/audiosource/doc/audiosource.rst index b1dcd61a8..3a247c503 100644 --- a/examples/multimedia/audiosource/doc/audiosource.rst +++ b/examples/multimedia/audiosource/doc/audiosource.rst @@ -1,6 +1,8 @@ Audio Source Example ==================== +.. tags:: Android + A Python application that demonstrates the analogous example in C++ `Audio Source Example <https://doc-snapshots.qt.io/qt6-dev/qtmultimedia-multimedia-audiosource-example.html>`_ diff --git a/examples/multimedia/camera/doc/camera.rst b/examples/multimedia/camera/doc/camera.rst index 8ef9f6700..7fc75a387 100644 --- a/examples/multimedia/camera/doc/camera.rst +++ b/examples/multimedia/camera/doc/camera.rst @@ -1,6 +1,8 @@ Camera Example =============== +.. tags:: Android + The Camera Example shows how to use the API to capture a still image or video. The Camera Example demonstrates how you can use Qt Multimedia to implement some diff --git a/examples/qml/editingmodel/doc/editingmodel.rst b/examples/qml/editingmodel/doc/editingmodel.rst index 60bb24f53..2b45b23f0 100644 --- a/examples/qml/editingmodel/doc/editingmodel.rst +++ b/examples/qml/editingmodel/doc/editingmodel.rst @@ -1,6 +1,8 @@ QAbstractListModel in QML ========================= +.. tags:: Android + This example shows how to add, remove and move items inside a QML ListView, but showing and editing the data via roles using a QAbstractListModel from Python. diff --git a/examples/qml/usingmodel/doc/usingmodel.rst b/examples/qml/usingmodel/doc/usingmodel.rst index 11b476d09..06a1b27b0 100644 --- a/examples/qml/usingmodel/doc/usingmodel.rst +++ b/examples/qml/usingmodel/doc/usingmodel.rst @@ -1,6 +1,8 @@ Using Model Example =================== +.. tags:: Android + A Python application that demonstrates how to use a :ref:`QAbstractListModel` with QML. diff --git a/examples/quick/models/objectlistmodel/doc/objectlistmodel.rst b/examples/quick/models/objectlistmodel/doc/objectlistmodel.rst index d71ee61df..a4af62706 100644 --- a/examples/quick/models/objectlistmodel/doc/objectlistmodel.rst +++ b/examples/quick/models/objectlistmodel/doc/objectlistmodel.rst @@ -1,6 +1,8 @@ Object List Model Example ========================= +.. tags:: Android + A list of QObject values can also be used as a model. A list[QObject,] provides the properties of the objects in the list as roles. diff --git a/examples/quick/models/stringlistmodel/doc/stringlistmodel.rst b/examples/quick/models/stringlistmodel/doc/stringlistmodel.rst index 4c00ed130..ce11674b4 100644 --- a/examples/quick/models/stringlistmodel/doc/stringlistmodel.rst +++ b/examples/quick/models/stringlistmodel/doc/stringlistmodel.rst @@ -1,6 +1,8 @@ String List Model Example ========================= +.. tags:: Android + A model may be a simple 'list', which provides the contents of the list via the modelData role. diff --git a/examples/quick/painteditem/doc/painteditem.rst b/examples/quick/painteditem/doc/painteditem.rst index 6f12355ca..5c3e8935b 100644 --- a/examples/quick/painteditem/doc/painteditem.rst +++ b/examples/quick/painteditem/doc/painteditem.rst @@ -1,6 +1,8 @@ Scene Graph Painted Item Example ================================ +.. tags:: Android + Shows how to implement QPainter-based custom scenegraph items. The Painted Item example shows how to use the QML Scene Graph framework to diff --git a/examples/quickcontrols/contactslist/doc/contactslist.rst b/examples/quickcontrols/contactslist/doc/contactslist.rst index 918e23760..b5540e39b 100644 --- a/examples/quickcontrols/contactslist/doc/contactslist.rst +++ b/examples/quickcontrols/contactslist/doc/contactslist.rst @@ -1,6 +1,8 @@ Qt Quick Controls - Contact List ================================ +.. tags:: Android + A QML app using Qt Quick Controls and a Python class that implements a simple contact list. This example can also be deployed to Android using **pyside6-android-deploy** diff --git a/examples/quickcontrols/gallery/doc/gallery.rst b/examples/quickcontrols/gallery/doc/gallery.rst index 29cd49f14..acd5096f6 100644 --- a/examples/quickcontrols/gallery/doc/gallery.rst +++ b/examples/quickcontrols/gallery/doc/gallery.rst @@ -1,6 +1,8 @@ Qt Quick Controls 2 - Gallery ============================= +.. tags:: Android + The gallery example is a simple application with a drawer menu that contains all the Qt Quick Controls 2. Each menu item opens a page that shows the graphical appearance of a control, allows you to interact with the control, and diff --git a/examples/widgets/widgets/digitalclock/doc/digitalclock.rst b/examples/widgets/widgets/digitalclock/doc/digitalclock.rst index ef800d9c0..d13275d24 100644 --- a/examples/widgets/widgets/digitalclock/doc/digitalclock.rst +++ b/examples/widgets/widgets/digitalclock/doc/digitalclock.rst @@ -1,6 +1,8 @@ Digital Clock Example ===================== +.. tags:: Android + The Digital Clock example shows how to use QLCDNumber to display a number with LCD-like digits. diff --git a/requirements-doc.txt b/requirements-doc.txt index 174a88787..6bc00f321 100644 --- a/requirements-doc.txt +++ b/requirements-doc.txt @@ -1,6 +1,7 @@ sphinx==7.2.6 sphinx-design==0.5.0 sphinx-copybutton==0.5.2 +sphinx-tags==0.3.1 myst-parser==2.0.0 furo==2023.9.10 graphviz==0.20 diff --git a/sources/pyside6/doc/conf.py.in b/sources/pyside6/doc/conf.py.in index 6292176bf..dd2d5ea9b 100644 --- a/sources/pyside6/doc/conf.py.in +++ b/sources/pyside6/doc/conf.py.in @@ -30,7 +30,7 @@ extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.ifconfig', 'sphinx.ext.coverage', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.graphviz', 'inheritance_diagram', 'pysideinclude', 'sphinx.ext.viewcode', - 'sphinx_design', 'sphinx_copybutton', 'myst_parser'] + 'sphinx_design', 'sphinx_copybutton', 'myst_parser', 'sphinx_tags',] myst_enable_extensions = [ "amsmath", @@ -229,3 +229,10 @@ if @SKIP_SPHINX_WARNINGS@: # -- Options for qthelp output --------------------------------------------------- qthelp_theme = 'pysidedocs_qthelp' + +# for example tagging based on supported platforms +tags_create_tags = True +tags_create_badges = True +tags_badge_colors = { + "Android": "info", +} |