andy5995
99d6eb9cb4
docs: Emphasize requirement to give filenames as arguments
...
(related to #5430 )
2022-12-12 23:40:07 -06:00
andy5995
6e7ecb02f1
docs: Update deprecated G_APPLICATION_FLAGS_NONE
2022-12-10 01:12:13 -06:00
Matthias Clasen
942f8d4b4b
Deprecate GtkInfoBar
...
This widget has a dialog-like API, which is something
we want to get rid of in GTK 5, and libadwaita has
a replacement with AdwBanner incoming.
2022-11-23 13:00:09 -05:00
Emmanuele Bassi
bd66198b88
docs: Add more links to the list widgets description
2022-11-11 11:30:41 +00:00
Emmanuele Bassi
5193846787
docs: Add links to the list widgets table
...
Make it easier for readers to go to the appropriate replacement for the
old GtkTreeView-and-friends API.
2022-11-11 11:21:17 +00:00
Arjan Molenaar
920f49e993
Fix typo in 4 to 5 migration page
2022-11-10 22:41:26 +01:00
Arjan Molenaar
29d7f93e38
Update Common Questions section on tree views
...
Point users to GtkListView instead of the
deprecated GtkTreeView.
2022-11-10 22:41:26 +01:00
Pedro Sader Azevedo
32e138689e
Link the file mentioned as a reference for key values
2022-11-06 01:54:38 +00:00
Matthias Clasen
9948053cd7
Deprecate GtkDialog
...
GtkDialog is too flexible in terms of UI (headerbars vs action bar,
etc), and has archaic APIs. It is time to retire it.
2022-10-29 15:27:53 -04:00
Matthias Clasen
8324a93c73
Update docs
...
Mention new deprecations in the future migration guide.
2022-10-29 14:14:59 -04:00
Emmanuele Bassi
21bc2c5078
docs: Remove mentions of Glade
...
Glade does not support GTK4, so we should not link to it when discussing
developing GTK4 applications.
2022-10-24 20:11:50 +01:00
Matthias Clasen
ac1ea6faca
docs: Remove mention of ~/.gtk-4.0
...
We are not looking there anymore, for a long time.
Fixes : #3266
2022-10-19 14:36:48 -04:00
Matthias Clasen
46c7c0c4e6
docs: Document new buildertool options
2022-10-19 13:36:14 -04:00
Matthias Clasen
cd031de680
docs: Update gtk4-builder-tool docs
...
Mention the new --deprecations option of the
validate command.
2022-10-19 08:50:34 -04:00
Matthias Clasen
9f8abc5d74
docs: Add a cross-reference
...
Note that GtkTreeView is deprecated and link to the
list view introduction from 'Tree and List Widget Overview'.
2022-10-12 22:26:40 -04:00
Matthias Clasen
0c94db7147
Start a migration guide for GTK 5
...
No need to panic, GTK 5 is still years away!
But it is good to write this material down while
it is fresh in mind.
2022-10-12 16:39:28 -04:00
Matthias Clasen
6c95547c3f
docs: Some updates
...
Make the section about environment variables match
current code.
Add a warning about env vars not being stable and
only for debugging.
2022-09-21 21:59:33 -04:00
Mitchell Hentges
fa554a8e85
Update GTK on Windows link: use gtk.org, not wiki
...
The old wiki page has a couple issues:
* It's out-of-date, not having any notes for GTK4 specifically,
and it doesn't link to `gvsbuild`, which (I believe) is
the current official (and best) way to build GTK with MSVC.
* It's "locked", so it's harder for contributors to update. This
is OK, except for one spicy detail:
* It's not clear how to contribute/report issues on the locked wiki
pages, so out-of-date information falls off the radar.
Regardless :) the gtk.org GTK for Windows docs are a much better
springboard, in my opinion.
2022-09-21 20:12:21 +02:00
Chun-wei Fan
f2b85fa1c7
running.md: Mention about issue with Nahimic on Windows
...
Let people know that they will need to use GTK with the Nahimic service
disabled or OpenGL disabled or put their GTK application into the Nahimic
backlist, or try to use GLES, since there is a known issue in the Windows
nVidia graphics drivers and Nahimic that causes GL operations to fail,
causing crashes in operations such as window resizes.
This will close issue #4113--sadly, there is nothing we can do within
GTK to fix the issue.
2022-08-02 13:50:49 +08:00
Manuel Zabelt
93636d4c5a
Update docs/reference/gdk/gdk4-x11.toml.in
2022-05-24 13:37:43 +00:00
Manuel Zabelt
88f761f2c8
GDK is LGPL-2.1-or-later not GPL-2.1-or-later, right?
2022-05-24 13:36:07 +00:00
Matthias Clasen
ad4536e825
Merge branch 'install-node-editor' into 'main'
...
Install gtk4-node-editor
See merge request GNOME/gtk!4701
2022-05-07 12:09:29 +00:00
Matthias Clasen
f9afee0667
Add a man page for gtk4-node-editor
2022-05-07 07:18:36 -04:00
Matthias Clasen
376d95a549
Updated screenshots
...
Produced by running the screenshot command over the
ui files in the same directory.
2022-05-06 23:05:15 -04:00
Matthias Clasen
a3ac414465
Generate screenshots on the fly
...
This commit adds a new meson option -Dupdate_screenshots=true.
When it is enabled, and -Dgtk_doc=true is also used, then the
build will generate images to include in the API docs from
ui files in docs/reference/gtk/images.
Note: we still keep a copy of the images in git, in order to
allow building without a display connection. To update the
images in git, the generated images need to be copied back
from the builddir to the srcdir.
2022-05-06 22:59:22 -04:00
Matthias Clasen
8ee6203e2c
Remove the old doc shooter infrastructure
...
This is no longer used.
2022-05-06 22:59:22 -04:00
Matthias Clasen
499687a11d
gtk-builder-tool: Add a screenshot command
...
This is an obvious variation of the preview
command. It can save a .ui file as either
.png or .node.
2022-04-17 12:57:46 -04:00
aneejit1
91511a80ac
Check for 'rst2man' misses installed 'rst2man.py' ( #4728 )
...
By default, 'docutils' installs 'rst2man' as 'rst2man.py'. Amend the
check for 'rst2man' to look for 'rst2man.py' as well if 'rst2man' is
not found.
2022-03-19 13:58:40 +00:00
Matthias Clasen
88fa226223
Fix a documentation typo
...
It is XDG_DATA_HOME.
Fixes : #4747
2022-03-04 22:18:06 -07:00
Emmanuele Bassi
7a608bda27
docs: Split dependencies from related libraries
...
We currently list everything as a dependencies, regardless of whether
it actually is; this is a source of confusion for users that read the
GTK documentation.
Gi-docgen has a new "related" key in the project configuration which
allows us to list libraries that are merely related to the namespace
we are documenting; the "dependencies" key is used to document the
actual namespace dependencies, now.
2022-02-12 17:28:00 +00:00
Sri Ramkrishna
6633f4e02f
Update docs/reference/gtk/migrating-3to4.md
2022-01-19 19:24:01 +00:00
Emmanuele Bassi
ca2aa52ba9
docs: Point to the correct development branch
...
The default development branch of GTK is now "main".
2022-01-13 14:39:39 +00:00
Emmanuele Bassi
96d28738c9
docs: Point source links to the correct branch
...
The default development branch for GTK is now "main".
2022-01-13 14:39:03 +00:00
Fabian Kirsch
4f36583898
corrected small typo input-handling.md
2022-01-12 09:02:01 +00:00
Matthias Clasen
fb5b2d3d8e
docs; Update supported backends
...
Some strings have changed here.
2022-01-06 14:56:16 -05:00
Jakub Kulík
484c0fdd15
docs: Mention GtkImage and GtkPicture changes
2021-12-17 00:32:08 +00:00
Matthias Clasen
5a42ccc575
docs: Clarify a sentence in the migration guide
...
Make it clear that we are giving examples of
no-longer existing APIs here.
Fixes : #4479
2021-11-30 19:51:22 -05:00
Mohammed Salman
4c8081bafc
Update section-text-widget.md
2021-11-17 22:48:14 +00:00
Emmanuele Bassi
39e4e48fdc
docs: Enable OpenSearch on our references
...
By adding the `docs_url` key in the project configuration file,
gi-docgen will generate an OpenSearch XML file, which allows to add
docs.gtk.org/<reference> as a "search engine" in web browsers.
2021-11-15 15:31:35 +00:00
Matthias Clasen
9f2dbf4fc5
Merge branch 'master' into 'master'
...
Fix typos
See merge request GNOME/gtk!4132
2021-11-09 11:28:35 +00:00
Emmanuele Bassi
0e27a49d1a
docs: Fix typo in link
2021-11-07 23:23:36 +00:00
Emmanuele Bassi
59f45aa30c
docs: Fix wrong fragments in type links
...
Due to a bug in gi-docgen we're not getting a warning if a fragment to a
type does not match the actual type, and we're generating a broken link.
See: https://gitlab.gnome.org/GNOME/gi-docgen/-/merge_requests/120
2021-11-07 18:40:24 +00:00
Hodong Kim
0632e94e68
Fix typos
2021-11-07 16:48:39 +09:00
Emmanuele Bassi
142571d0b8
build: Collect gi-docgen's common arguments
...
And only enable `--fatal-warnings` if `-Dwerror` has been set, just like
we do for the introspection data generation.
2021-11-01 13:00:51 +00:00
Link Dupont
9e0494cf4d
docs: match hello world code to description
...
Add the creation of a GtkBox to the hello-world sample code.
Fixes : #4358
2021-10-19 22:40:20 -04:00
Matthias Clasen
922e6add38
Merge branch 'docs-window-position' into 'master'
...
docs: Mention gtk_window_set_position() being gone
See merge request GNOME/gtk!4048
2021-10-11 06:36:23 +00:00
Emmanuele Bassi
c7bb4a9678
docs: Add GdkPixbuf to the URL map
...
Allow cross-linking to the GdkPixbuf reference.
2021-10-09 10:55:24 +01:00
Emmanuele Bassi
0054f8bd74
docs: Mention gtk_window_set_position() being gone
...
People search for it in the migration guide much more than other
GdkSurface and GtkWindow methods.
2021-10-08 12:27:24 +01:00
Emmanuele Bassi
a816f81ecd
docs: Fix links in the Getting Started page
...
We still have links to old gtk-doc references, as well as links to
developer.gnome.org locations that don't exist any more. On the other
hand, we are missing a bunch of links to existing types and symbols.
2021-10-01 01:44:01 +01:00
Matthias Clasen
83b434d6a5
docs: Mention popovers in the migration guide
...
Things have changed around popovers, we should mention
that.
2021-09-28 15:47:06 -04:00