Matthias Clasen
b6cd97be1e
docs: Escape some xml tags
...
When mentioning xml tags in markdown, we must write
them as `<foo>`, or they will come out mangled.
2021-06-04 08:06:18 -04:00
Matthias Clasen
c4cbd6ec1b
docs: Mention <packing> in migration guide
...
Add another hint for what to do with child properties.
Fixes : #3950
2021-06-04 07:59:07 -04:00
Emmanuele Bassi
f9f9fa6dc6
docs: Fix the license field
...
It's LGPL-2.1-or-later, not GPL.
2021-06-03 09:11:09 +01:00
Emmanuele Bassi
6d06b0f076
Enable fatal warnings when build the docs
...
We want to fail the CI pipeline when the documentation generator emits a
warning.
2021-05-25 13:32:32 +01:00
Matthias Clasen
4c2761302a
doc: Syntax fixes
...
No, we can't have links that say [constructor@...] or
[mehtod@...] or [methoc@...] or [methos@...] or [metohd@...].
And no, not [signals@...] either.
2021-05-25 07:33:55 -04:00
Matthias Clasen
808e5421a9
docs: Convince the widget gallery to reflow
2021-05-24 10:51:02 -04:00
Matthias Clasen
71aac48042
docs: More syntax fixes
...
[`func@Foo`] is not the right link syntax either.
2021-05-22 21:20:10 -04:00
Matthias Clasen
8bcc6b1d96
docs: Fix up syntax
...
There's no [type_func@...[ syntax, it is all [func@...].
2021-05-22 20:56:14 -04:00
Matthias Clasen
40f292cb13
docs: Sync up debug flag information
2021-05-22 20:46:59 -04:00
Matthias Clasen
b617ba1c82
docs: Refer to backend APIs
...
Add links to the backend api docs.
2021-05-22 17:25:26 -04:00
Matthias Clasen
252edbdbc6
docs: Fix a typo
2021-05-22 17:25:26 -04:00
Matthias Clasen
0bba3610c5
docs: Avoid stairstepping
...
If you don't put empty lines between the items in a
definition list, markdown helpfully stairsteps them.
We don't want that!
2021-05-22 17:25:26 -04:00
Matthias Clasen
fc9f580fd3
docs: Update GSK_RENDERER docs
...
This did not mention the opengl and ngl values yet.
2021-05-22 17:25:26 -04:00
Matthias Clasen
2d0957b732
docs: Clean up docs syntax
...
Replace leftover gtk-doc syntax (#Type) with backquotes.
2021-05-21 15:34:47 -04:00
Matthias Clasen
642f32e14d
Merge branch 'ebassi/for-master' into 'master'
...
Install documentation in the appropriate place
See merge request GNOME/gtk!3408
2021-05-03 19:21:18 +00:00
Emmanuele Bassi
29382360ed
docs: Add missing extra files for gdk4 sub-references
...
The Wayland and X11 references need the gtk-logo.svg and the urlmap.js
extra files.
Fixes : #3905
2021-04-28 01:44:47 +01:00
Eli Schwartz
e5b0d225de
meson: only build demo manpages when demos are enabled
...
Installing them even when manpages are enabled, but the demos are
disabled, produces manpages for unavailable programs...
2021-04-13 22:55:03 -04:00
Emmanuele Bassi
99c7ba7840
Install documentation in the appropriate place
...
We're already installing each reference into its own namespaced
directory, so we don't need to add further path elements.
Additionally, with the changes in:
https://gitlab.gnome.org/GNOME/devhelp/-/merge_requests/20
https://gitlab.gnome.org/GNOME/gi-docgen/-/merge_requests/54
we can browse the GTK API references in DevHelp.
2021-04-07 14:57:31 +01:00
Matthias Clasen
65a061f3c2
Merge branch 'ebassi/broadway-docs' into 'master'
...
docs: Update the Broadway instructions
See merge request GNOME/gtk!3380
2021-03-31 21:42:59 +00:00
Emmanuele Bassi
7bfff6c51e
docs: Update the links to the docs of GTK dependencies
...
Use docs.gtk.org where appropriate.
Fixes : #3817
2021-03-31 20:51:27 +01:00
Emmanuele Bassi
3fdedce8f6
docs: Update the Broadway instructions
...
The Broadway server binary is now versioned, and it's not compatible
with the GTK3 server.
2021-03-31 20:06:54 +01:00
Emmanuele Bassi
7c29847fbf
build: Install the API references
...
We are building them, but not installing them.
2021-03-12 11:32:09 +00:00
Emmanuele Bassi
66f0547ebf
docs: Fix the dependencies links
...
Use the GitLab pages location until we can link to a proper space on
developer.gnome.org.
2021-03-12 11:18:37 +00:00
Emmanuele Bassi
c5ddf5b381
docs: Add URL maps for cross links
2021-03-11 16:46:02 +00:00
Emmanuele Bassi
61712bfb3b
docs: Enable search
2021-03-11 16:37:38 +00:00
Emmanuele Bassi
c3eb3f2943
docs: Update the "running GTK apps" section
...
Style the content a bit better, and use the appropriate links.
2021-03-11 16:37:38 +00:00
Matthias Clasen
d13e592dbf
Small updates to the coding and documentation style
...
Mention summary sentences, and a few other things.
2021-03-11 16:37:38 +00:00
Emmanuele Bassi
90cf6bb686
docs: Show class hierarchy in the API references
2021-03-11 16:37:38 +00:00
Matthias Clasen
102884faf1
docs: Remove anchors from list overview
...
Our markdown doesn't support this.
2021-03-11 16:37:35 +00:00
Matthias Clasen
465aca029e
Add some more widgets to the gallery
...
We already have images for menus, menubars and emoji chooser.
Use them.
2021-03-11 16:37:33 +00:00
Matthias Clasen
b39160243f
aboutdialog: Improve example image
...
Use our logo, and update the copyright years.
2021-03-11 16:37:33 +00:00
Matthias Clasen
a61c677a0d
docs: Add dialogs to the gallery
2021-03-11 16:37:33 +00:00
Matthias Clasen
34443546a8
visual index: Reorder some widgets
...
This improves the alignment a bit.
2021-03-11 16:37:32 +00:00
Emmanuele Bassi
6bc69a12cc
docs: Update the documentation style guide
2021-03-11 16:37:32 +00:00
Matthias Clasen
dfb68fb13d
docs: Split images for check and radio buttons
...
Its the same widget, but two images fit better in the gallery,
and will be easier to use as example images in the docs.
2021-03-11 16:37:31 +00:00
Matthias Clasen
18f525f7b4
docs: Improve the togglebutton image
...
Make it actually show toggles.
2021-03-11 16:37:31 +00:00
Emmanuele Bassi
952fc31dbc
docs: Fix up the 3-to-4 migration guide
2021-03-11 16:37:31 +00:00
Matthias Clasen
93326164e2
docs: Add backend links to the gdk docs
...
These are placeholders for when we know how to
link across namespaces.
2021-03-11 16:37:31 +00:00
Matthias Clasen
b78895e449
docs: Add separate toml files for gdk backends
...
Reusing the same one duplicates the standalone
docs, which doesn't quite seem right.
2021-03-11 16:37:31 +00:00
Matthias Clasen
e82d090bf5
docs: Add some links to the pango chapter
2021-03-11 16:37:31 +00:00
Matthias Clasen
3d04c0f4be
docs: Move GdkEvent docs inline
...
This is not really worth a chapter of its own.
2021-03-11 16:37:31 +00:00
Matthias Clasen
e5bed812f5
docs: Tweak X11 section
...
Remove unsupported heading anchors.
2021-03-11 16:37:31 +00:00
Matthias Clasen
d88a4629f9
docs: Tweaks Windows section
...
Remove unsupported heading anchors.
2021-03-11 16:37:31 +00:00
Matthias Clasen
24c04b5bb9
docs: Tweak Wayland section
...
Remove unsupported heading anchors.
2021-03-11 16:37:31 +00:00
Matthias Clasen
4c3ea25745
docs: Tweak a11y section
...
Convert link syntax.
2021-03-11 16:37:31 +00:00
Matthias Clasen
231814a595
docs: Tweak running chapter
...
Remove unsupported heading anchors, fix definition
list use.
2021-03-11 16:37:31 +00:00
Matthias Clasen
820f37be0b
docs: Tweak input overview
...
Remove unsupported heading anchors.
2021-03-11 16:37:31 +00:00
Matthias Clasen
02ec00dc5a
docs: Tweak drawing model overview
...
Fix link syntax, remove gtk-doc markup.
2021-03-11 16:37:30 +00:00
Matthias Clasen
4d2e4309f0
docs: Tweak css properties section
...
Fix the use of definition lists.
2021-03-11 16:37:30 +00:00
Matthias Clasen
d2ba09ec98
docs: Tweak the actions overview
...
Fix use of definition lists, and remove some gtk-doc
markup.
2021-03-11 16:37:30 +00:00
Matthias Clasen
41ddce152a
building: Minor tweaks
...
Remove unsupported anchors from headings.
2021-03-11 16:37:30 +00:00
Emmanuele Bassi
6d489a9e81
docs: Generate the DevHelp file for our namespaces
2021-03-11 16:37:30 +00:00
Emmanuele Bassi
85774d2bcd
docs: Update the "Getting Started" page
...
Drop the Pandoc stuff, add the gi-docgen links, and remove a stray
docbook element.
2021-03-11 16:37:30 +00:00
Matthias Clasen
b9a02b0c24
docs: Bring the widget gallery back
...
We have all the images, lets put them to use.
2021-03-11 16:37:30 +00:00
Emmanuele Bassi
701f1b837b
docs: Show summary in the namespace index
2021-03-11 16:37:30 +00:00
Emmanuele Bassi
3ef95b4065
build: Quiet down gi-docgen
...
We are only interested in the warnings and errors.
2021-03-11 16:37:30 +00:00
Emmanuele Bassi
d621a37a60
docs: Fix up the style of the X11 content file
2021-03-11 16:37:30 +00:00
Emmanuele Bassi
6f93e63d21
docs: Move detached sections into their own content file
2021-03-11 16:37:30 +00:00
Emmanuele Bassi
b9f0cf1c8b
docs: Move gdkcairo section to an external file
2021-03-11 16:37:30 +00:00
Emmanuele Bassi
abb33bd65f
docs: Move the gtkmain section to its own document
...
The introspection data does not handle unattached sections like gtk-doc
does, so we need to move what was gtkmain into its own Markdown
document.
2021-03-11 16:37:30 +00:00
Emmanuele Bassi
f85b847410
docs: Add metadata preamble to GTK's content files
2021-03-11 16:37:30 +00:00
Emmanuele Bassi
a6ee0dd8aa
docs: Drop gtk-doc files
...
We don't use gtk-doc to generate our API reference, so we don't need its
files lying around any more.
2021-03-11 16:37:30 +00:00
Emmanuele Bassi
0ba2a3a191
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-03-11 16:37:30 +00:00
Emmanuele Bassi
676ea489cc
docs: Remove invalid macros
2021-03-07 18:34:53 +00:00
Matthias Clasen
4b9aeaf9e3
imcontext: Add [gs]et_surrounding_with_selection
...
The Wayland text protocol expects to get both ends
of the selection with its surrounding call, so make
that available via GtkIMContext. We add this as new
api and vfuncs, and fall back, so that existing
implementations keep working.
2021-03-04 15:18:30 -05:00
Matthias Clasen
b0a82b1dfe
Merge branch 'popup-shadow-width' into 'master'
...
Support shadows on popovers
See merge request GNOME/gtk!3089
2021-02-14 17:22:50 +00:00
António Fernandes
a810f600bf
docs: Mark heading in migration guide
...
This heading was missing from the index because it was not marked as one
2021-02-14 15:20:54 +00:00
Matthias Clasen
ea19f7c360
popuplayout: Add shadow width
...
Add shadow width to the GdkPopupLayout struct. This
information is needed by the compositor to make correct
positioning decisions about popups.
2021-02-13 21:01:46 -05:00
Matthias Clasen
ea7185bdb1
cssfiltervalue: Implement drop-shadows
...
We have all the pieces, so this is surprisingly easy.
2021-02-06 16:16:43 -05:00
Matthias Clasen
0a0a059397
docs: Mention css drop-shadow filter
...
We don't support this filter, currently.
2021-02-03 22:10:13 -05:00
Matthias Clasen
edeaf9c040
imcontext: Drop GTK_MAX_COMPOSE_LEN
...
Drop GTK_MAX_COMPOSE_LEN from docs. It is no longer
used by GTK at all. We leave the define in place
for now, to avoid breaking 3rd party code that might
use it.
2021-02-01 12:31:23 -05:00
Matthias Clasen
3c66c27caa
docs: Add gtk_widget_grab_default to migration guide
...
Point out the replacement for this api.
2021-01-27 13:50:05 -05:00
Matthias Clasen
5ee7606779
css: Support colors in cross fades
...
The CSS Image Spec (Level 4) allows colors in
cross-fade expressions to specify solid-color images.
Support this.
2021-01-26 21:14:09 -05:00
Matthias Clasen
51122dd287
docs: Cosmetics
...
Tweak the css docs slightly.
2021-01-26 20:33:16 -05:00
Matthias Clasen
40eae298d5
docs: Update border-size docs
...
GtkCenterLayout respected border-size as well.
2021-01-26 10:40:22 -05:00
Matthias Clasen
65a4118d50
css: Support overline
...
We can support text-decoration-line: overline,
since pango supports it now.
2021-01-26 00:04:04 -05:00
Matthias Clasen
344f9fcf05
css: Implement transform-origin
...
Implement most of transform-origin. We only
handle the xy components currently, which lets
us reuse the position value implementation that
is used for background-position.
2021-01-24 22:49:08 -05:00
Matthias Clasen
4c971cd4da
docs: Fix reference for css transform
...
Refer to the canonical location for the css
transform spec.
2021-01-24 22:48:00 -05:00
Matthias Clasen
3a18a6dddf
docs: Update getting started section
...
We were still talking about draw signals here,
which don't exist anymore.
Fixes : #3601
2021-01-20 08:01:54 -05:00
Matthias Clasen
880468f5a3
docs: Fix a heading gotcha
...
One of the many migration guide sections was too
prominent.
2021-01-14 08:13:34 -05:00
Matthias Clasen
6ddbb2a402
doc: Clarify some migration hints
...
Don't mention GdkSurface::layout as replacement for
GtkWindow::configure-event. Instead, explain how to
save window state.
2021-01-14 07:52:36 -05:00
Matthias Clasen
f03acaf7ab
Merge branch 'mcatanzaro/unparent' into 'master'
...
Remove incorrect unparenting guidance from migration guide
See merge request GNOME/gtk!3050
2021-01-07 18:35:37 +00:00
Matthias Clasen
4e7ce9edcf
Merge branch 'mcatanzaro/gtkbuilder-docs' into 'master'
...
Improve GtkBuilder documentation
See merge request GNOME/gtk!3055
2021-01-07 18:00:19 +00:00
Michael Catanzaro
59692599ea
Remove incorrect unparenting guidance from migration guide
...
This rule is almost always wrong, and we're having some trouble agreeing
on replacement text. Let's remove the whole paragraph for now, to avoid
confusion.
2021-01-07 11:39:53 -06:00
Michael Catanzaro
c736deb83b
Add section on GtkBuilder API changes to GTK 4 migration guide
...
Thanks to Benjamin for helping with the language.
2021-01-07 11:34:42 -06:00
Michael Catanzaro
137f32f9ef
Expand event controller API changes section of GTK 4 porting guide
...
There is more to say about changes to GtkEventController.
2021-01-07 10:53:09 -06:00
Emmanuele Bassi
e4d0114e0d
docs: Add migration section for GtkClipboard
...
A simple copy/paste text example, plus directing people towards the
appropriate GType to replace the old convenience API.
2021-01-05 16:51:14 +00:00
Emmanuele Bassi
1995b7f34b
docs: Preformat some symbols
2021-01-05 16:19:21 +00:00
Matthias Clasen
9595d440cf
docs: Flesh out Popup layout docs
...
We have nice illustrations for this, lets use them.
2021-01-05 08:37:23 -05:00
Matthias Clasen
cf623ce774
Merge branch 'window-geometry-info' into 'master'
...
gtk/window: remove GtkWindowGeometryInfo from public header file
See merge request GNOME/gtk!3028
2021-01-04 13:55:08 +00:00
Matthias Clasen
f2e5775380
Merge branch 'matthiasc/for-master' into 'master'
...
Matthiasc/for master
Closes #3506 and #3530
See merge request GNOME/gtk!3024
2021-01-01 22:48:11 +00:00
Matthias Clasen
572649740e
docs: Flesh out the gtk4-builder-tool man page
...
Add some details about the --3to4 conversion, and
set expectations.
2021-01-01 10:14:01 -05:00
David Lechner
4fb70c5e4d
gtk/window: remove GtkWindowGeometryInfo from public header file
...
GtkWindowGeometryInfo is only used by static methods in gtkwindow.c
so it doesn't need to be in the public header file.
2020-12-30 01:32:27 -06:00
Matthias Clasen
878b34fae3
gtk4-encode-symbolic: Add debug output
...
Add a --debug option that makes this tool produce
some debug output that can be helpful in tracking
down why symbolic svgs are broken.
2020-12-29 21:30:52 -05:00
Matthias Clasen
7e579bb59a
Merge branch 'wip/otte/for-master' into 'master'
...
Wip/otte/for master
See merge request GNOME/gtk!2997
2020-12-24 07:13:22 +00:00
Benjamin Otte
f85d939e5e
docs: Put render nodes in their own sections
2020-12-24 06:38:45 +01:00
Emmanuele Bassi
6c31ed53f4
docs: Fix typo and whitespace
2020-12-21 17:03:42 +00:00
wisp3rwind
9521f609d8
docs: backtick fixes
...
- in the gettext() examples, at least the _() triggers italics
- add missing closing backtick
2020-12-18 16:31:41 +01:00
Matthias Clasen
d33062795c
Merge branch 'ebassi/docs-for-master' into 'master'
...
Ebassi/docs for master
See merge request GNOME/gtk!2971
2020-12-17 23:59:41 +00:00
Matthias Clasen
3f56e8191f
Merge branch 'shortcuts' into 'master'
...
docs: Add separation between kinds of shortcuts in Keyboard input
See merge request GNOME/gtk!2964
2020-12-17 19:43:38 +00:00