aboutsummaryrefslogtreecommitdiffstats
path: root/sources/pyside6
diff options
context:
space:
mode:
authorShyamnath Premnadh <Shyamnath.Premnadh@qt.io>2024-08-14 11:52:45 +0200
committerCristián Maureira-Fredes <Cristian.Maureira-Fredes@qt.io>2024-08-16 16:03:13 +0200
commit96e233535c05462ea0ddaa72ce88c0ccc6fbf45b (patch)
tree4119d557742bd3ed4da281144562b25f2745413b /sources/pyside6
parent64c6d6fbecda160d16006e22b6cc0c1f77785508 (diff)
Docs: Fix sphinx warnings
- Mostly toctree warnings, missing file paths and indentation issues. Change-Id: I3531f3b7ab3341dd21955ffe73664916b81ecfa2 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
Diffstat (limited to 'sources/pyside6')
-rw-r--r--sources/pyside6/doc/conf.py.in2
-rw-r--r--sources/pyside6/doc/developer/documentation.rst4
-rw-r--r--sources/pyside6/doc/tools/index.rst22
3 files changed, 25 insertions, 3 deletions
diff --git a/sources/pyside6/doc/conf.py.in b/sources/pyside6/doc/conf.py.in
index 0deea6eb1..16335ac04 100644
--- a/sources/pyside6/doc/conf.py.in
+++ b/sources/pyside6/doc/conf.py.in
@@ -176,7 +176,7 @@ html_logo = "@CMAKE_CURRENT_SOURCE_DIR@/_static/qtforpython.png"
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
-html_favicon = "_static/qtforpython.ico"
+html_favicon = "@CMAKE_CURRENT_SOURCE_DIR@/_static/qtforpython.ico"
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
diff --git a/sources/pyside6/doc/developer/documentation.rst b/sources/pyside6/doc/developer/documentation.rst
index 517bd46f1..2d8d32fcb 100644
--- a/sources/pyside6/doc/developer/documentation.rst
+++ b/sources/pyside6/doc/developer/documentation.rst
@@ -67,7 +67,7 @@ The others have main-test drivers for checking.
There are 2 scripts used for determining the inheritance:
* ``json_inheritance.py`` (env var ``INHERITANCE_FILE``) reads a
- inheritance.json file containing the class hierarchy generated by
- shiboken's doc generator.
+inheritance.json file containing the class hierarchy generated by
+shiboken's doc generator.
* ``import_inheritance.py`` actually tries to import the class (legacy)
diff --git a/sources/pyside6/doc/tools/index.rst b/sources/pyside6/doc/tools/index.rst
index b421a428f..41d4697db 100644
--- a/sources/pyside6/doc/tools/index.rst
+++ b/sources/pyside6/doc/tools/index.rst
@@ -209,3 +209,25 @@ Qt Quick 3D
:link-type: ref
a graphical user interface for the ``pyside6-balsam`` tool.
+
+.. toctree::
+ :hidden:
+
+ pyside-assistant
+ pyside-designer
+ pyside-genpyi
+ pyside-linguist
+ pyside-lrelease
+ pyside-lupdate
+ pyside-metaobjectdump
+ pyside-project
+ pyside-qml
+ pyside-qmlcachegen
+ pyside-qmllint
+ pyside-qmltyperegistrar
+ pyside-rcc
+ pyside-uic
+ pyside6-balsam
+ pyside6-balsamui
+ pyside6-qmlimportscanner
+ pyside6-qsb