aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorCristian Maureira-Fredes <Cristian.Maureira-Fredes@qt.io>2021-04-16 20:26:32 +0200
committerCristian Maureira-Fredes <Cristian.Maureira-Fredes@qt.io>2021-04-18 20:15:03 +0200
commita4c722d3d47feee45e9bbbe09871eb25efe6f86d (patch)
tree19237b96e7ddd66529af5cf80d97dcaa8afef448
parent2cceb85c30995f94d69516eff519e7d7d2aa941f (diff)
doc: use sphinx panels in shiboken docs
Replacing the old raw HTML for online docs. The HTML version of the menu will remain for qthelp. Pick-to: 6.0 Task-number: PYSIDE-1112 Change-Id: I335b25c561ab9d45fd041d24ec607b8d603612c1 Reviewed-by: Christian Tismer <tismer@stackless.com>
-rw-r--r--sources/shiboken6/doc/conf.py.in2
-rw-r--r--sources/shiboken6/doc/index.rst71
2 files changed, 71 insertions, 2 deletions
diff --git a/sources/shiboken6/doc/conf.py.in b/sources/shiboken6/doc/conf.py.in
index fd8c17837..a54fa7ef2 100644
--- a/sources/shiboken6/doc/conf.py.in
+++ b/sources/shiboken6/doc/conf.py.in
@@ -23,7 +23,7 @@ import sys, os
# 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.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.ifconfig',
-'sphinx.ext.coverage']
+ 'sphinx.ext.coverage', 'sphinx_panels']
output_format='@DOC_OUTPUT_FORMAT@'
diff --git a/sources/shiboken6/doc/index.rst b/sources/shiboken6/doc/index.rst
index dcebdfe19..e1fc5e5ce 100644
--- a/sources/shiboken6/doc/index.rst
+++ b/sources/shiboken6/doc/index.rst
@@ -25,7 +25,76 @@ Shiboken
Documentation
=============
-.. raw:: html
+.. 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
+
+ Install and build from source.
+
+ +++
+
+ .. link-button:: gettingstarted
+ :type: ref
+ :text: Getting Started
+ :classes: btn-qt btn-block stretched-link
+ ---
+
+ Binding generator executable.
+
+ +++
+
+ .. link-button:: shibokengenerator
+ :type: ref
+ :text: Shiboken Generator
+ :classes: btn-qt btn-block stretched-link
+ ---
+
+ Python utility module.
+
+ +++
+
+ .. link-button:: shibokenmodule
+ :type: ref
+ :text: Shiboken Module
+ :classes: btn-qt btn-block stretched-link
+
+ ---
+
+ Reference and functionallities.
+
+ +++
+
+ .. link-button:: typesystem
+ :type: ref
+ :text: Type System
+ :classes: btn-qt btn-block stretched-link
+
+ ---
+
+ Using Shiboken.
+
+ +++
+
+ .. link-button:: examples/index
+ :type: ref
+ :text: Examples
+ :classes: btn-qt btn-block stretched-link
+
+ ---
+
+ Known issues and FAQ.
+
+ +++
+
+ .. link-button:: considerations
+ :type: ref
+ :text: Considerations
+ :classes: btn-qt btn-block stretched-link
+
+.. ifconfig:: output_format == 'qthelp'
<table class="special">
<colgroup>