AuroraMiddleware/gtk2
1
0
Fork 0
forked from AuroraMiddleware/gtk
Code Issues Pull Requests Projects Releases Wiki Activity
5cc6b3e342
gtk2/docs/reference/gdk/meson.build

98 lines
2.5 KiB
Meson
Raw Normal View History

Generate GTK API reference(s) with gi-docgen Stop using gtk-doc, and switch to gi-docgen. The gi-docgen tool generates API references through the introspection data, which has various benefits: - it does not parse C code - it does not generate and run C code to introspect types at build time - it does not present a different API from the one we're exporting Additionally, gi-docgen: - does not generate DocBook XML in order to generate HTML - does not go through xsltproc - parses proper Markdown Which makes it markedly faster than gtk-doc has ever been.
2021-02-10 13:41:53 +00:00
expand_content_md_files = [
build: Generate the API references (WIP) Still a work in progress.
2017-04-19 10:35:45 +00:00
]
meson: Rename documentation option to gtk_doc This name is what most of the stack is using. Lets follow along, even though it is (imo) uglier.
2019-07-01 16:57:16 +00:00
if get_option('gtk_doc')
docs: Update the URL for related documentation And install the gi-docgen project files for GDK.
2021-07-31 18:05:33 +00:00
gdk4_toml = configure_file(
input: 'gdk4.toml.in',
output: 'gdk4.toml',
configuration: toml_conf,
install: true,
install_dir: docs_dir / 'gdk4',
)
Generate GTK API reference(s) with gi-docgen Stop using gtk-doc, and switch to gi-docgen. The gi-docgen tool generates API references through the introspection data, which has various benefits: - it does not parse C code - it does not generate and run C code to introspect types at build time - it does not present a different API from the one we're exporting Additionally, gi-docgen: - does not generate DocBook XML in order to generate HTML - does not go through xsltproc - parses proper Markdown Which makes it markedly faster than gtk-doc has ever been.
2021-02-10 13:41:53 +00:00
custom_target('gdk4-doc',
input: [ gdk4_toml, gdk_gir[0] ],
output: 'gdk4',
command: [
gidocgen,
'generate',
build: Quiet down gi-docgen We are only interested in the warnings and errors.
2021-02-18 13:38:29 +00:00
'--quiet',
Enable fatal warnings when build the docs We want to fail the CI pipeline when the documentation generator emits a warning.
2021-05-25 12:32:32 +00:00
'--fatal-warnings',
Generate GTK API reference(s) with gi-docgen Stop using gtk-doc, and switch to gi-docgen. The gi-docgen tool generates API references through the introspection data, which has various benefits: - it does not parse C code - it does not generate and run C code to introspect types at build time - it does not present a different API from the one we're exporting Additionally, gi-docgen: - does not generate DocBook XML in order to generate HTML - does not go through xsltproc - parses proper Markdown Which makes it markedly faster than gtk-doc has ever been.
2021-02-10 13:41:53 +00:00
'--add-include-path=@0@'.format(meson.current_build_dir() / '../../../gtk'),
'--config=@INPUT0@',
'--output-dir=@OUTPUT@',
'--no-namespace-dir',
'--content-dir=@0@'.format(meson.current_source_dir()),
'@INPUT1@',
build: Use a consistent style for Meson files
2020-12-15 12:31:38 +00:00
],
Generate GTK API reference(s) with gi-docgen Stop using gtk-doc, and switch to gi-docgen. The gi-docgen tool generates API references through the introspection data, which has various benefits: - it does not parse C code - it does not generate and run C code to introspect types at build time - it does not present a different API from the one we're exporting Additionally, gi-docgen: - does not generate DocBook XML in order to generate HTML - does not go through xsltproc - parses proper Markdown Which makes it markedly faster than gtk-doc has ever been.
2021-02-10 13:41:53 +00:00
depend_files: [ expand_content_md_files ],
build_by_default: true,
build: Install the API references We are building them, but not installing them.
2021-03-12 11:13:54 +00:00
install: true,
install_dir: docs_dir,
build: Use a consistent style for Meson files
2020-12-15 12:31:38 +00:00
)
Generate GTK API reference(s) with gi-docgen Stop using gtk-doc, and switch to gi-docgen. The gi-docgen tool generates API references through the introspection data, which has various benefits: - it does not parse C code - it does not generate and run C code to introspect types at build time - it does not present a different API from the one we're exporting Additionally, gi-docgen: - does not generate DocBook XML in order to generate HTML - does not go through xsltproc - parses proper Markdown Which makes it markedly faster than gtk-doc has ever been.
2021-02-10 13:41:53 +00:00
if x11_enabled
docs: Update the URL for related documentation And install the gi-docgen project files for GDK.
2021-07-31 18:05:33 +00:00
gdk4x11_toml = configure_file(
input: 'gdk4-x11.toml.in',
output: 'gdk4-x11.toml',
configuration: toml_conf,
install: true,
install_dir: docs_dir / 'gdk4-x11',
)
Generate GTK API reference(s) with gi-docgen Stop using gtk-doc, and switch to gi-docgen. The gi-docgen tool generates API references through the introspection data, which has various benefits: - it does not parse C code - it does not generate and run C code to introspect types at build time - it does not present a different API from the one we're exporting Additionally, gi-docgen: - does not generate DocBook XML in order to generate HTML - does not go through xsltproc - parses proper Markdown Which makes it markedly faster than gtk-doc has ever been.
2021-02-10 13:41:53 +00:00
custom_target('gdk4-x11-doc',
docs: Add separate toml files for gdk backends Reusing the same one duplicates the standalone docs, which doesn't quite seem right.
2021-02-21 15:38:39 +00:00
input: [ gdk4x11_toml, gdk_x11_gir[0] ],
Generate GTK API reference(s) with gi-docgen Stop using gtk-doc, and switch to gi-docgen. The gi-docgen tool generates API references through the introspection data, which has various benefits: - it does not parse C code - it does not generate and run C code to introspect types at build time - it does not present a different API from the one we're exporting Additionally, gi-docgen: - does not generate DocBook XML in order to generate HTML - does not go through xsltproc - parses proper Markdown Which makes it markedly faster than gtk-doc has ever been.
2021-02-10 13:41:53 +00:00
output: 'gdk4-x11',
command: [
gidocgen,
'generate',
build: Quiet down gi-docgen We are only interested in the warnings and errors.
2021-02-18 13:38:29 +00:00
'--quiet',
Enable fatal warnings when build the docs We want to fail the CI pipeline when the documentation generator emits a warning.
2021-05-25 12:32:32 +00:00
'--fatal-warnings',
Generate GTK API reference(s) with gi-docgen Stop using gtk-doc, and switch to gi-docgen. The gi-docgen tool generates API references through the introspection data, which has various benefits: - it does not parse C code - it does not generate and run C code to introspect types at build time - it does not present a different API from the one we're exporting Additionally, gi-docgen: - does not generate DocBook XML in order to generate HTML - does not go through xsltproc - parses proper Markdown Which makes it markedly faster than gtk-doc has ever been.
2021-02-10 13:41:53 +00:00
'--add-include-path=@0@'.format(meson.current_build_dir() / '../../../gtk'),
'--config=@INPUT0@',
'--output-dir=@OUTPUT@',
'--no-namespace-dir',
'--content-dir=@0@'.format(meson.current_source_dir()),
'@INPUT1@',
],
depends: [ gdk_gir[0] ],
docs: Add separate toml files for gdk backends Reusing the same one duplicates the standalone docs, which doesn't quite seem right.
2021-02-21 15:38:39 +00:00
depend_files: [ ],
Generate GTK API reference(s) with gi-docgen Stop using gtk-doc, and switch to gi-docgen. The gi-docgen tool generates API references through the introspection data, which has various benefits: - it does not parse C code - it does not generate and run C code to introspect types at build time - it does not present a different API from the one we're exporting Additionally, gi-docgen: - does not generate DocBook XML in order to generate HTML - does not go through xsltproc - parses proper Markdown Which makes it markedly faster than gtk-doc has ever been.
2021-02-10 13:41:53 +00:00
build_by_default: true,
build: Install the API references We are building them, but not installing them.
2021-03-12 11:13:54 +00:00
install: true,
install_dir: docs_dir,
Generate GTK API reference(s) with gi-docgen Stop using gtk-doc, and switch to gi-docgen. The gi-docgen tool generates API references through the introspection data, which has various benefits: - it does not parse C code - it does not generate and run C code to introspect types at build time - it does not present a different API from the one we're exporting Additionally, gi-docgen: - does not generate DocBook XML in order to generate HTML - does not go through xsltproc - parses proper Markdown Which makes it markedly faster than gtk-doc has ever been.
2021-02-10 13:41:53 +00:00
)
endif
if wayland_enabled
docs: Update the URL for related documentation And install the gi-docgen project files for GDK.
2021-07-31 18:05:33 +00:00
gdk4wayland_toml = configure_file(
input: 'gdk4-wayland.toml.in',
output: 'gdk4-wayland.toml',
configuration: toml_conf,
install: true,
install_dir: docs_dir / 'gdk4-wayland',
)
Generate GTK API reference(s) with gi-docgen Stop using gtk-doc, and switch to gi-docgen. The gi-docgen tool generates API references through the introspection data, which has various benefits: - it does not parse C code - it does not generate and run C code to introspect types at build time - it does not present a different API from the one we're exporting Additionally, gi-docgen: - does not generate DocBook XML in order to generate HTML - does not go through xsltproc - parses proper Markdown Which makes it markedly faster than gtk-doc has ever been.
2021-02-10 13:41:53 +00:00
custom_target('gdk4-wayland-doc',
docs: Add separate toml files for gdk backends Reusing the same one duplicates the standalone docs, which doesn't quite seem right.
2021-02-21 15:38:39 +00:00
input: [ gdk4wayland_toml, gdk_wayland_gir[0] ],
Generate GTK API reference(s) with gi-docgen Stop using gtk-doc, and switch to gi-docgen. The gi-docgen tool generates API references through the introspection data, which has various benefits: - it does not parse C code - it does not generate and run C code to introspect types at build time - it does not present a different API from the one we're exporting Additionally, gi-docgen: - does not generate DocBook XML in order to generate HTML - does not go through xsltproc - parses proper Markdown Which makes it markedly faster than gtk-doc has ever been.
2021-02-10 13:41:53 +00:00
output: 'gdk4-wayland',
command: [
gidocgen,
'generate',
build: Quiet down gi-docgen We are only interested in the warnings and errors.
2021-02-18 13:38:29 +00:00
'--quiet',
Enable fatal warnings when build the docs We want to fail the CI pipeline when the documentation generator emits a warning.
2021-05-25 12:32:32 +00:00
'--fatal-warnings',
Generate GTK API reference(s) with gi-docgen Stop using gtk-doc, and switch to gi-docgen. The gi-docgen tool generates API references through the introspection data, which has various benefits: - it does not parse C code - it does not generate and run C code to introspect types at build time - it does not present a different API from the one we're exporting Additionally, gi-docgen: - does not generate DocBook XML in order to generate HTML - does not go through xsltproc - parses proper Markdown Which makes it markedly faster than gtk-doc has ever been.
2021-02-10 13:41:53 +00:00
'--add-include-path=@0@'.format(meson.current_build_dir() / '../../../gtk'),
'--config=@INPUT0@',
'--output-dir=@OUTPUT@',
'--no-namespace-dir',
'--content-dir=@0@'.format(meson.current_source_dir()),
'@INPUT1@',
],
depends: [ gdk_gir[0] ],
docs: Add separate toml files for gdk backends Reusing the same one duplicates the standalone docs, which doesn't quite seem right.
2021-02-21 15:38:39 +00:00
depend_files: [ ],
Generate GTK API reference(s) with gi-docgen Stop using gtk-doc, and switch to gi-docgen. The gi-docgen tool generates API references through the introspection data, which has various benefits: - it does not parse C code - it does not generate and run C code to introspect types at build time - it does not present a different API from the one we're exporting Additionally, gi-docgen: - does not generate DocBook XML in order to generate HTML - does not go through xsltproc - parses proper Markdown Which makes it markedly faster than gtk-doc has ever been.
2021-02-10 13:41:53 +00:00
build_by_default: true,
build: Install the API references We are building them, but not installing them.
2021-03-12 11:13:54 +00:00
install: true,
install_dir: docs_dir,
Generate GTK API reference(s) with gi-docgen Stop using gtk-doc, and switch to gi-docgen. The gi-docgen tool generates API references through the introspection data, which has various benefits: - it does not parse C code - it does not generate and run C code to introspect types at build time - it does not present a different API from the one we're exporting Additionally, gi-docgen: - does not generate DocBook XML in order to generate HTML - does not go through xsltproc - parses proper Markdown Which makes it markedly faster than gtk-doc has ever been.
2021-02-10 13:41:53 +00:00
)
endif
meson: allow building man pages without the documentation The 'documentation' option also guarded the man page build. Instead if skipping the whole docs subdir skip the specific gtkdoc calls, so that the man page build still works. This brings it in line with the gtk3 meson build.
2019-05-25 16:27:32 +00:00
endif
Reference in New Issue Copy Permalink