aboutsummaryrefslogtreecommitdiffstats
path: root/sources/pyside6/doc/pyside-examples/examples.qdoc
diff options
context:
space:
mode:
authorCristian Maureira-Fredes <Cristian.Maureira-Fredes@qt.io>2021-02-17 22:24:06 +0100
committerCristian Maureira-Fredes <Cristian.Maureira-Fredes@qt.io>2021-03-17 10:56:04 +0100
commitf930fce091fbcc0cdc4d1d57ee688966b26ea53e (patch)
tree30446e4c5185e9f1f8653878bcc31da46130e588 /sources/pyside6/doc/pyside-examples/examples.qdoc
parent3a18da91353a71e801658329c55b170c18bcd824 (diff)
doc: use 'doc' directory for examples gallery
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>
Diffstat (limited to 'sources/pyside6/doc/pyside-examples/examples.qdoc')
0 files changed, 0 insertions, 0 deletions