aboutsummaryrefslogtreecommitdiffstats
path: root/sources/pyside6
diff options
context:
space:
mode:
Diffstat (limited to 'sources/pyside6')
-rw-r--r--sources/pyside6/doc/_themes/pysidedocs/static/pyside.css18
-rw-r--r--sources/pyside6/doc/conf.py.in9
-rw-r--r--sources/pyside6/doc/contents.rst4
-rw-r--r--sources/pyside6/doc/deployment.rst2
-rw-r--r--sources/pyside6/doc/gettingstarted.rst6
-rw-r--r--sources/pyside6/doc/index.rst120
6 files changed, 124 insertions, 35 deletions
diff --git a/sources/pyside6/doc/_themes/pysidedocs/static/pyside.css b/sources/pyside6/doc/_themes/pysidedocs/static/pyside.css
index 6b9fe3f05..506b61d15 100644
--- a/sources/pyside6/doc/_themes/pysidedocs/static/pyside.css
+++ b/sources/pyside6/doc/_themes/pysidedocs/static/pyside.css
@@ -2158,3 +2158,21 @@ div.leftside {
div.rightside {
margin-left: 50%;
}
+
+.btn-qt:hover,
+.btn-qt:active,
+.btn-qt:focus,
+.btn-qt.active {
+ background: #41cd52;
+ color: #fff !important;
+ border-color: #fff;
+}
+
+/* Using !important is not recommended, but out CSS is being added
+ * to the pages before the bootstrap ones, so we cannot override them
+ * without using it */
+.btn-qt {
+ color: #41cd52 !important;
+ border-color: #41cd52 !important;
+ font-weight: bold !important;
+}
diff --git a/sources/pyside6/doc/conf.py.in b/sources/pyside6/doc/conf.py.in
index 9b274fa1f..55726f21a 100644
--- a/sources/pyside6/doc/conf.py.in
+++ b/sources/pyside6/doc/conf.py.in
@@ -29,10 +29,11 @@ if @HAS_WEBENGINE_WIDGETS@:
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
#extensions = ['sphinx.ext.todo', 'sphinx.ext.graphviz', 'inheritance_diagram', 'pysideinclude']
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_tabs.tabs']
+ 'sphinx.ext.coverage', 'sphinx.ext.intersphinx', 'sphinx.ext.todo',
+ 'sphinx.ext.graphviz', 'inheritance_diagram', 'pysideinclude',
+ 'sphinx.ext.viewcode',
+ 'sphinx_panels',
+ ]
output_format='@DOC_OUTPUT_FORMAT@'
diff --git a/sources/pyside6/doc/contents.rst b/sources/pyside6/doc/contents.rst
index bb849ce6c..b11298016 100644
--- a/sources/pyside6/doc/contents.rst
+++ b/sources/pyside6/doc/contents.rst
@@ -15,6 +15,10 @@
licenses.rst
modules.rst
considerations.rst
+..
+ Intersphinx references in toctrees is not supported
+ https://github.com/sphinx-doc/sphinx/issues/1836
+..
shiboken6/index.rst
Module Index
diff --git a/sources/pyside6/doc/deployment.rst b/sources/pyside6/doc/deployment.rst
index 4d5f0185c..550273c22 100644
--- a/sources/pyside6/doc/deployment.rst
+++ b/sources/pyside6/doc/deployment.rst
@@ -1,4 +1,4 @@
-.. _deployment:
+.. _deployment-guides:
|project| Deployment
====================
diff --git a/sources/pyside6/doc/gettingstarted.rst b/sources/pyside6/doc/gettingstarted.rst
index bfdcc92b4..e5731c4d3 100644
--- a/sources/pyside6/doc/gettingstarted.rst
+++ b/sources/pyside6/doc/gettingstarted.rst
@@ -17,10 +17,10 @@ On **Linux** you might get them with your operating system package manager, on *
you might get them with ``brew``, and on **Windows** you can download the installer from each
website.
- * **Python**: 3.6+ `[official website] <https://www.python.org/downloads/>`_
+ * **Python**: 3.6+ `[official Python website] <https://www.python.org/downloads/>`_
* **Qt:** 6.0+ `[online installer] <https://download.qt.io/official_releases/online_installers/>`_
- * **CMake:** 3.18+ `[official website] <https://cmake.org/download/>`_
- * **Git:** 2.0+. `[official website] <https://git-scm.com/downloads>`_
+ * **CMake:** 3.18+ `[official CMake website] <https://cmake.org/download/>`_
+ * **Git:** 2.0+. `[official Git website] <https://git-scm.com/downloads>`_
* **libclang:** The libclang library, recommended: version 10 for 6.0+.
Prebuilt versions for each OS can be `downloaded here`_.
diff --git a/sources/pyside6/doc/index.rst b/sources/pyside6/doc/index.rst
index 212df0185..c982c7c3b 100644
--- a/sources/pyside6/doc/index.rst
+++ b/sources/pyside6/doc/index.rst
@@ -38,34 +38,102 @@ Documentation
.. ifconfig:: output_format == 'html'
- .. raw:: 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
- <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>
+ Write your first Qt application.
- <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:: quickstart
+ :type: ref
+ :text: Check it out!
+ :classes: btn-qt btn-block stretched-link
+ ---
+
+ Install and build from source.
+
+ +++
+
+ .. link-button:: gettingstarted
+ :type: ref
+ :text: Getting Started
+ :classes: btn-qt btn-block stretched-link
+ ---
+
+ PySide API reference.
-.. ifconfig :: output_format == 'qthelp'
+ +++
+
+ .. link-button:: api
+ :type: ref
+ :text: API Docs
+ :classes: btn-qt btn-block stretched-link
+
+ ---
+
+ Learn with step-by-step guides.
+
+ +++
+
+ .. link-button:: tutorials/index
+ :type: ref
+ :text: Tutorials
+ :classes: btn-qt btn-block stretched-link
+ ---
+
+ Check all the available examples.
+
+ +++
+
+ .. link-button:: examples/index
+ :type: ref
+ :text: Examples
+ :classes: btn-qt btn-block stretched-link
+ ---
+
+ Watch webinars, talks, and more.
+
+ +++
+
+ .. link-button:: videos
+ :type: ref
+ :text: Videos
+ :classes: btn-qt btn-block stretched-link
+
+ ---
+
+ Learn to deploy your applications.
+
+ +++
+
+ .. link-button:: deployment-guides
+ :type: ref
+ :text: Deployment
+ :classes: btn-qt btn-block stretched-link
+ ---
+
+ API differences and known issues.
+
+ +++
+
+ .. link-button:: considerations
+ :type: ref
+ :text: Considerations
+ :classes: btn-qt btn-block stretched-link
+ ---
+
+ 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
@@ -80,13 +148,11 @@ Documentation
<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>
@@ -94,6 +160,7 @@ Documentation
</tr>
</table>
+
We have also a `wiki page`_ where you can find how to report bugs, contribute or contact the community.
.. _`wiki page`: https://wiki.qt.io/Qt_for_Python
@@ -104,5 +171,4 @@ We have also a `wiki page`_ where you can find how to report bugs, contribute or
contents.rst
gettingstarted*
- pyside-examples/pysideexamples*
overviews/*
generated by cgit v1.2.3 (git 2.25.1) at 2024-06-08 19:29:24 +0000