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 |
|