weston/doc/sphinx/toc/meson.build

# you need to add here any files you add to the toc directory as well
files = [
	'kiosk-shell.rst',
	'ivi-shell.rst',
	'running-weston.rst',
	'libweston.rst',
	'test-suite.rst',
	'test-suite-api.rst',
]

foreach file : files
	configure_file(input: file, output: file, copy: true)
endforeach

subdir('images')
subdir('libweston')
build: Add sphinx/breathe support for generating documentation This is adds basic configuration files for doxygen and for breathe, which is a doxygen-to-sphinx bridge that can document C symbols. Breathe is configured with default project 'weston' and implicitly adds :members: and :undoc-members: to breathe configuration options. This allows a shorter way to call breathe directives without the need specify the project and also to display implicitly all the members, documented or not. A 'docs' run_target to force the docs to be re-built has been added. Initially (the first time the build system is ran) the documentation will automatically be built, but later re-builds will require the use of the 'docs' target. This avoid further delays in building weston but in the same time allows the possiblity to update/improve the documentation bits to those who want that. Signed-off-by: Marius Vlad <marius.vlad@collabora.com> 2019-06-14 12:41:02 +03:00			`# you need to add here any files you add to the toc directory as well`
doc: overview of the test suite This should lower the barrier to entry for writing more tests. Signed-off-by: Pekka Paalanen <pekka.paalanen@collabora.com> 2019-11-18 16:13:19 +02:00			`files = [`
kiosk-shell: Introduce kiosk/fullscreen shell for desktop apps kiosk-shell is fullscreen shell for apps that use the xdg-shell protocol. The goal is to make life easier for people shipping embedded devices with simple fullscreen shell requirements, and reduce the proliferation of desktop-shell hacks. Top level surfaces are made fullscreen, whereas dialogs are placed on top in the center of the output and retain their natural sizes. Dialogs can be moved and (un)maximized, but resizing is currently not supported. An app can be directed to a particular output by populating the "app-ids" field with the app's XDG app id, in the relevant "[output]" section in the weston config file. Fixes: #277 Signed-off-by: Alexandros Frantzis <alexandros.frantzis@collabora.com> 2020-04-21 18:23:37 +03:00			`'kiosk-shell.rst',`
doc: update and move IVI-shell README to doc The README for the IVI-shell is completely outdated. Update the documentation, add some more information on the IVI-shell use cases and explain how to use and customize the IVI-shell. Also convert the file to rst and move it to doc directory next to the kiosk-shell documentation. Signed-off-by: Michael Tretter <m.tretter@pengutronix.de> 2022-07-29 10:39:37 +02:00			`'ivi-shell.rst',`
doc: Add running-weston.rst file Documentation file for explaning in more detail how to run weston, using launcher direct and specifying a non-default seat. This explains how to create a udev file and assign a particular GPU card to it, and potentially, other input devices. It also describes a bit additional arguments that can be passed on, as an introduction to using the DRM node for that particular seat. Fixes #460 Signed-off-by: Marius Vlad <marius.vlad@collabora.com> 2020-12-14 23:02:06 +02:00			`'running-weston.rst',`
doc: overview of the test suite This should lower the barrier to entry for writing more tests. Signed-off-by: Pekka Paalanen <pekka.paalanen@collabora.com> 2019-11-18 16:13:19 +02:00			`'libweston.rst',`
			`'test-suite.rst',`
			`'test-suite-api.rst',`
			`]`
build: Add sphinx/breathe support for generating documentation This is adds basic configuration files for doxygen and for breathe, which is a doxygen-to-sphinx bridge that can document C symbols. Breathe is configured with default project 'weston' and implicitly adds :members: and :undoc-members: to breathe configuration options. This allows a shorter way to call breathe directives without the need specify the project and also to display implicitly all the members, documented or not. A 'docs' run_target to force the docs to be re-built has been added. Initially (the first time the build system is ran) the documentation will automatically be built, but later re-builds will require the use of the 'docs' target. This avoid further delays in building weston but in the same time allows the possiblity to update/improve the documentation bits to those who want that. Signed-off-by: Marius Vlad <marius.vlad@collabora.com> 2019-06-14 12:41:02 +03:00
			`foreach file : files`
			`configure_file(input: file, output: file, copy: true)`
			`endforeach`

doc: update and move IVI-shell README to doc The README for the IVI-shell is completely outdated. Update the documentation, add some more information on the IVI-shell use cases and explain how to use and customize the IVI-shell. Also convert the file to rst and move it to doc directory next to the kiosk-shell documentation. Signed-off-by: Michael Tretter <m.tretter@pengutronix.de> 2022-07-29 10:39:37 +02:00			`subdir('images')`
build: Add sphinx/breathe support for generating documentation This is adds basic configuration files for doxygen and for breathe, which is a doxygen-to-sphinx bridge that can document C symbols. Breathe is configured with default project 'weston' and implicitly adds :members: and :undoc-members: to breathe configuration options. This allows a shorter way to call breathe directives without the need specify the project and also to display implicitly all the members, documented or not. A 'docs' run_target to force the docs to be re-built has been added. Initially (the first time the build system is ran) the documentation will automatically be built, but later re-builds will require the use of the 'docs' target. This avoid further delays in building weston but in the same time allows the possiblity to update/improve the documentation bits to those who want that. Signed-off-by: Marius Vlad <marius.vlad@collabora.com> 2019-06-14 12:41:02 +03:00			`subdir('libweston')`