Commit 1fde12ce authored by Fabian Riethmayer's avatar Fabian Riethmayer

Added doxylink to the project. Inital set of links to Qt and Kirigami API

parent 6db70037
This diff is collapsed.
This diff is collapsed.
......@@ -148,6 +148,12 @@ shown instead.
Code
----
API
~~~
- :kirigamiapi:`Kirigami: InlineMessage <InlineMessage>`
- :kwidgetsaddons:`QtWidgets: KMessageWidget <KMessageWidget>`
Kirigami
~~~~~~~~
......
......@@ -84,3 +84,14 @@ Here are some general recommendations for card layouts:
.. image:: /img/Card2.qml.png
:alt: Padding for text and buttons
Code
----
API
~~~
- :kirigamiapi:`Kirigami: Card <Card>`
- :kirigamiapi:`Kirigami: CardsGridView <CardsGridView>`
- :kirigamiapi:`Kirigami: CardsLayout <CardsLayout>`
- :kirigamiapi:`Kirigami: CardsListView <CardsListView>`
......@@ -197,3 +197,11 @@ like , that will take care of lay outing and spacing of your controls.
for checkbox items.
- Do not use ending punctuation (neither dot nor colon) for group
label.
Code
----
API
~~~
- `QML: CheckBox <https://doc.qt.io/qt-5/qml-qtquick-controls-checkbox.html>`_
......@@ -78,3 +78,11 @@ Appearance
- Create a buddy relation so access keys are assigned.
- End each label with a colon.
- Use :doc:`sentence style capitalization </style/writing/capitalization>` for items.
Code
----
API
~~~
- `QML: ComboBox <https://doc.qt.io/qt-5/qml-qtquick-controls-combobox.html>`_
......@@ -34,3 +34,12 @@ Appearance
- Overlay buttons are placed at the bottom right corner
- Grid has a PaperWhite background on desktop, an no background on
mobile
Code
----
API
~~~
- `QML: GridView <https://doc.qt.io/qt-5/qml-qtquick-gridview.html>`_
- :kirigamiapi:`Kirigami: CardsGridView <CardsGridView>`
......@@ -287,6 +287,15 @@ Ordering
Code
----
API
~~~
- `QML: ListView <https://doc.qt.io/qt-5/qml-qtquick-listview.html>`_
- :kirigamiapi:`Kirigami: CardsListView <CardsListView>`
- :kirigamiapi:`Kirigami: AbstractListItem <AbstractListItem>`
- :kirigamiapi:`Kirigami: BasicListItem <BasicListItem>`
- :kirigamiapi:`Kirigami: SwipeListItem <SwipeListItem>`
Kirigami
~~~~~~~~
......
......@@ -177,3 +177,12 @@ which will take care of laying out and spacing of your controls.
for radio buttons.
- Do not use ending punctuation (neither dot nor colon) for group
label.
Code
----
API
~~~
- `QML: RadioButton
<https://doc.qt.io/qt-5/qml-qtquick-controls-radiobutton.html>`_
......@@ -111,3 +111,11 @@ Slider and Spinbox together
the label that should give focus directly to the spin box.
- Mark significant values along the length of the slider with text or
tick marks.
Code
----
API
~~~
- `QML: Slider <https://doc.qt.io/qt-5/qml-qtquick-controls-slider.html>`_
......@@ -63,3 +63,11 @@ Appearance
the user might want to compare two numerical values in the same
column of controls. In this case, ensure the right edges of the
relevant controls are also aligned.
Code
----
API
~~~
- `QML: SpinBox <https://doc.qt.io/qt-5/qml-qtquick-controls2-spinbox.html>`_
......@@ -69,6 +69,13 @@ If your application is using :doc:`column-based navigation </patterns/navigation
Code
----
API
~~~
- :kirigamiapi:`Kirigami: Action <Action>`
- :kirigamiapi:`Kirigami: ScrollablePage <ScrollablePage>`
Kirigami
^^^^^^^^
......
......@@ -65,6 +65,9 @@ Guidelines
Code
----
- :kirigamiapi:`Kirigami: Action <Action>`
- :kirigamiapi:`Kirigami: ScrollablePage <ScrollablePage>`
Kirigami
^^^^^^^^
......
......@@ -98,6 +98,11 @@ collapsed icons-only state.
Code
----
API
~~~
- :kirigamiapi:`Kirigami: GlobalDrawer <GlobalDrawer>`
Kirigami
^^^^^^^^
......
......@@ -83,6 +83,12 @@ Appearance
Code
----
API
~~~
- :kirigamiapi:`Kirigami: ApplicationWindow <ApplicationWindow>`
- `QML: MenuBar <https://doc.qt.io/qt-5/qml-qtquick-controls-menubar.html>`_
Kirigami
^^^^^^^^
......
......@@ -99,6 +99,13 @@ Appearance
Code
----
API
~~~
- :kirigamiapi:`Kirigami: Action <Action>`
- :kirigamiapi:`Kirigami: ScrollablePage <ScrollablePage>`
- :kirigamiapi:`Kirigami: ActionToolBar <ActionToolBar>`
Kirigami
~~~~~~~~
......
......@@ -17,9 +17,9 @@
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))
import os
import sys
sys.path.insert(0, os.path.abspath('.'))
# -- General configuration ------------------------------------------------
......@@ -31,7 +31,7 @@
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = ['sphinx.ext.todo']
extensions = ['sphinx.ext.todo', 'sphinxcontrib.doxylink']
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
......@@ -198,6 +198,11 @@ rst_epilog = """
"""
doxylink = {
'kirigamiapi' : ('Kirigami2.tags.xml', 'https://api.kde.org/frameworks/kirigami/html/'), # https://api.kde.org/frameworks/kirigami/html/Kirigami2.tags
'kwidgetsaddons' : ('KWidgetsAddons.tags.xml', 'https://api.kde.org/frameworks/kwidgetsaddons/html/') # https://api.kde.org/frameworks/kwidgetsaddons/html/KWidgetsAddons.tags
}
rst_prolog = """
.. role:: iconred
.. role:: plasmablue
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment