[gtk/ebassi/gidocgen: 3/465] docs: Drop gtk-doc files

From: Emmanuele Bassi <ebassi src gnome org>
To: commits-list gnome org
Cc:
Subject: [gtk/ebassi/gidocgen: 3/465] docs: Drop gtk-doc files
Date: Mon, 8 Mar 2021 22:25:58 +0000 (UTC)

commit f6bd9f2a435bbcea3a953ef01febf1d7712d5539
Author: Emmanuele Bassi <ebassi gnome org>
Date:   Thu Feb 18 12:59:09 2021 +0000

    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.

 docs/reference/gdk/gdk4-docs.xml           |   89 -
 docs/reference/gdk/gdk4-overrides.txt      |   25 -
 docs/reference/gdk/gdk4-sections.txt       | 1350 -----
 docs/reference/gdk/gdk4.toml.in            |    8 +-
 docs/reference/gdk/gdk4.types              |   32 -
 docs/reference/gdk/version.xml.in          |    1 -
 docs/reference/gsk/gsk4-docs.xml           |   33 -
 docs/reference/gsk/gsk4-sections.txt       |  399 --
 docs/reference/gsk/gsk4.types              |    3 -
 docs/reference/gsk/version.xml.in          |    1 -
 docs/reference/gtk/gtk-markdown-to-docbook |  199 -
 docs/reference/gtk/gtk4-docs.xml           |  496 --
 docs/reference/gtk/gtk4-overrides.txt      |    0
 docs/reference/gtk/gtk4-sections.txt       | 7613 ----------------------------
 docs/reference/gtk/gtk4.toml.in            |    1 +
 docs/reference/gtk/gtk4.types.in           |  261 -
 docs/reference/gtk/meson.build             |    2 +
 docs/reference/gtk/overview.md             |   65 +
 docs/reference/gtk/version.xml.in          |    1 -
 docs/reference/gtk/visual_index.xml        |  109 -
 20 files changed, 72 insertions(+), 10616 deletions(-)
---
diff --git a/docs/reference/gdk/gdk4.toml.in b/docs/reference/gdk/gdk4.toml.in
index cf7f160125..d64dc616ec 100644
--- a/docs/reference/gdk/gdk4.toml.in
+++ b/docs/reference/gdk/gdk4.toml.in
@@ -14,10 +14,10 @@ dependencies = [ "GObject-2.0", "Graphene-1.0", "Pango-1.0" ]
   description = "The base type system library"
   docs_url = "https://developer.gnome.org/gobject/stable";
 
-  [dependencies."Graphene-1.0"]
-  name = "Graphene"
-  description = "A thin layer of mathematical types for 3D libraries"
-  docs_url = "https://ebassi.github.io/graphene/docs";
+  [dependencies."cairo-1.0"]
+  name = "Cairo"
+  description = "A 2D graphics library with support for multiple output devices"
+  docs_url = "https://www.cairographics.org/manual/";
 
   [dependencies."Pango-1.0"]
   name = "Pango"
diff --git a/docs/reference/gtk/gtk4.toml.in b/docs/reference/gtk/gtk4.toml.in
index f71d310373..04e77d89a9 100644
--- a/docs/reference/gtk/gtk4.toml.in
+++ b/docs/reference/gtk/gtk4.toml.in
@@ -43,6 +43,7 @@ base_url = "https://gitlab.gnome.org/GNOME/gtk/-/blob/master/";
 [extra]
 # The same order will be used when generating the index
 content_files = [
+  "overview.md",
   "getting_started.md",
   "building.md",
   "compiling.md",
diff --git a/docs/reference/gtk/meson.build b/docs/reference/gtk/meson.build
index b50bec2c18..792bde0a6f 100644
--- a/docs/reference/gtk/meson.build
+++ b/docs/reference/gtk/meson.build
@@ -1,11 +1,13 @@
 # XXX: gi-docgen needs a deps file
 expand_content_md_files = [
+  'overview.md',
   'broadway.md',
   'osx.md',
   'wayland.md',
   'windows.md',
   'x11.md',
   'getting_started.md',
+  'initialization.md',
   'resources.md',
   'building.md',
   'compiling.md',
diff --git a/docs/reference/gtk/overview.md b/docs/reference/gtk/overview.md
new file mode 100644
index 0000000000..6016861e80
--- /dev/null
+++ b/docs/reference/gtk/overview.md
@@ -0,0 +1,65 @@
+Title: Overview
+
+GTK is a library for creating graphical user interfaces. It works on many
+UNIX-like platforms, Windows, and macOS. GTK is released under the terms of
+the [GNU Library General Public License][gnu-lgpl], which allows for flexible
+licensing of client applications. GTK has a C-based, object-oriented
+architecture that allows for maximum flexibility and portability; there are
+bindings for many other languages, including C++, Objective-C, Guile/Scheme, Perl,
+Python, JavaScript, Rust, Go, TOM, Ada95, Free Pascal, and Eiffel.
+
+The GTK toolkit contains "widgets": GUI components such as buttons, text
+input, or windows.
+
+GTK depends on the following libraries:
+
+ - **GLib**: a general-purpose utility library, not specific to graphical
+   user interfaces. GLib provides many useful data types, macros, type
+   conversions, string utilities, file utilities, a main loop abstraction,
+   and so on. More information available on the [GLib website][glib].
+ - **GObject**: A library that provides a type system, a collection of
+   fundamental types including an object type, and a signal system. More
+   information available on the [GObject website][gobject].
+ - **GIO**: A modern, easy-to-use VFS API including abstractions for files,
+   drives, volumes, stream IO, as well as network programming and IPC though
+   DBus. More information available on the [GIO website][gio].
+ - **Cairo**: Cairo is a 2D graphics library with support for multiple
+   output devices. More information available on the [Cairo website][cairo].
+ - **OpenGL**: OpenGL is the premier environment for developing portable,
+   interactive 2D and 3D graphics applications. More information available
+   on the [Khronos website][opengl].
+ - **Pango**: Pango is a library for internationalized text handling. It
+   centers around the `PangoLayout` object, representing a paragraph of
+   text.  Pango provides the engine for `GtkTextView`, `GtkLabel`,
+   `GtkEntry`, and all GTK widgets that display text. More information
+   available on the [Pango website][pango].
+ - **gdk-pixbuf**: A small, portable library which allows you to create
+   `GdkPixbuf` ("pixel buffer") objects from image data or image files. You
+   can use `GdkPixbuf` in combination with widgets like `GtkImage` to
+   display images. More information available on the
+   [gdk-pixbuf website][gdkpixbuf].
+ - **graphene**: A small library which provides vector and matrix
+   datatypes and operations. Graphene provides optimized implementations
+   using various SIMD instruction sets such as SSE and ARM NEON. More
+   information available on the [Graphene website][graphene]
+
+GTK is divided into three parts:
+
+ - **GDK**: GDK is the abstraction layer that allows GTK to support multiple
+   windowing systems. GDK provides window system facilities on Wayland, X11,
+   Microsoft Windows, and Apple macOS.
+ - **GSK**: GSK is an API for creating a scene graph from drawing operation,
+   called "nodes", and rendering it using different backends. GSK provides
+   renderers for OpenGL, Vulkan and Cairo.
+ - **GTK**: The GUI toolkit, containing UI elements, layout managers, data
+   storage types for efficient use in GUI applications, and much more.
+
+[gnu-lgpl]: https://www.gnu.org/licenses/old-licenses/lgpl-2.1.en.html
+[glib]: https://developer.gnome.org/glib/stable/
+[gobject]: https://developer.gnome.org/gobject/stable/
+[gio]: https://developer.gnome.org/gio/stable/
+[cairo]: https://www.cairographics.org/manual/
+[opengl]: https://www.opengl.org/about/
+[pango]: https://pango.gnome.org/
+[gdkpixbuf]: https://developer.gnome.org/gdk-pixbuf/stable/
+[graphene]: https://ebassi.github.io/graphene/
[Date Prev][Date Next] [Thread Prev][Thread Next] [Thread Index] [Date Index] [Author Index]