| Commit message (Collapse) | Author | Age | Files | Lines |
|---|
| |
|
|
|
|
|
|
|
|
|
|
|
|
| |
Adding the option to display a screenshot on the
example gallery.
First, the script will look for an image with the same name
as the example, otherwise it will just get the first
in alphabetical order.
Pick-to: 6.0
Fixes: PYSIDE-1490
Change-Id: Ia0328c84206a3d66854197abe5ecad8d1d28abc5
Reviewed-by: Christian Tismer <tismer@stackless.com>
|
| |
|
|
|
|
|
|
| |
For the examples gallery tool
Pick-to: 6.0
Change-Id: Ia77d2d22033ccb35df30fa8ed4c7f78de070dec1
Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
There were two previous documented examples using the approach
based on qdoc: stardelegate, and classwizard.
This patch moves them into the 'doc/' directory for each example,
and partially revert the changes from
308157f01260c640e21f6972619d3b380c007acb
Additionally, an unrelated screenshot was moved to a new general
'images/' directory.
Task-number: PYSIDE-1112
Pick-to: 6.0
Change-Id: I239a24fa4e4f970540857ba8b33b9b13c18142b1
Reviewed-by: Christian Tismer <tismer@stackless.com>
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
This plugin replaces sphinx-tabs, so that's removed.
The panels plugin will add bootstrap responsive cards to the docs
allowing us to use them instead of the ad-hoc table we had.
Additionally, this changes the example gallery tool too,
since the main gallery was built using our own table implementation.
Since Panels also provides options to add content in tabs, with CSS
instead of JS (from sphinx-tabs), we update the generated examples
files.
Fixing warning messages related to files that didn't exist,
duplicated references, and redundant indexes.
Task-number: PYSIDE-1112
Pick-to: 6.0
Change-Id: Id19be92e72f0a18f63b76daf1898080f3e199626
Reviewed-by: Christian Tismer <tismer@stackless.com>
Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
The initial patch that generates a gallery based on the examples in the
respository, was limited to only showing the content of the files
in each '.pyproject' file.
That approach didn't allow to describe each example, nor add
complementary images, like screenshots to each example page.
This patch introduces the option to consider everything inside a 'doc/'
directory on the example directory. The files that are copied over are
not directory, but only files, for images to be the main focus.
For example, currently the Tetrix case contained the following files:
$ ls examples/widgets/tetrix/
tetrix.py
tetrix.pyproject
On this patch you can see that now there is a doc directory with the
following content:
$ ls examples/widgets/tetrix/doc
tetrix-screenshot.png
tetrix.rst
The example page that will be generated for this case will contain the
content of the 'doc/tetrix.rst' file, plus the content of all the
project files at the end.
The 'doc/tetrix.rst' file contains a reference to the
'tetrix-screenshot.png' image, so that file will be copied over too.
Task-number: PYSIDE-1112
Pick-to: 6.0
Change-Id: I2d11833c461d8073d2d2888576d876d3f834103a
Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
Before this patch, the auto-generated documentation page
had all the files from the .pyproject listed one after the other.
This uses a new sphinx extension called sphinx-tabs
https://github.com/executablebooks/sphinx-tabs
which allows us to easily add content in tabs.
Task-number: PYSIDE-1112
Pick-to: 6.0
Change-Id: Ibd66a8c911f05be13ae2700be6d3e95a2b98b775
Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
|
| |
|
|
|
|
|
|
|
|
| |
Add a --quiet option and use that for quiet builds.
Pick-to: 6.0
Task-number: PYSIDE-1490
Change-Id: I6b8a3fa159acb85dee5fbc064991a09a9fa6ceda
Reviewed-by: Christian Tismer <tismer@stackless.com>
Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
|
|
|
This script generates a gallery for all the example
currently in pyside-setup/examples.
Using this tool will overwrite the index rst file for the examples
located in 'sources/pyside6/doc/examples/index.rst
Additionally, to display the code of each example, this will generate
one extra .rst file for each example that contains a .pyproject file,
for example: 'sources/pysides6/doc/examples/example_widgets__tetrix.rst'
Currently, the usage of this tool is not incorporated in the
documentation building process.
Task-number: PYSIDE-1490
Pick-to: 6.0
Change-Id: I78546d4c7905fd8b521f4112457980b4d1d56860
Reviewed-by: Christian Tismer <tismer@stackless.com>
Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
|
