diff options
| -rw-r--r-- | sources/shiboken6/doc/conf.py.in | 2 | ||||
| -rw-r--r-- | sources/shiboken6/doc/index.rst | 71 |
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> |