diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/libgweather.toml.in | 3 | ||||
| -rw-r--r-- | doc/meson.build | 1 | ||||
| -rw-r--r-- | doc/migrating-3to4.md | 13 |
3 files changed, 17 insertions, 0 deletions
diff --git a/doc/libgweather.toml.in b/doc/libgweather.toml.in index 0baa11b..19a3613 100644 --- a/doc/libgweather.toml.in +++ b/doc/libgweather.toml.in @@ -35,6 +35,9 @@ base_url = "https://gitlab.gnome.org/GNOME/libgweather/-/blob/HEAD/" [extra] urlmap_file = "urlmap.js" +content_files = [ + "migrating-3to4.md", +] [[object]] pattern = "DEPRECATED" diff --git a/doc/meson.build b/doc/meson.build index 7ee4cd0..419f979 100644 --- a/doc/meson.build +++ b/doc/meson.build @@ -17,6 +17,7 @@ if get_option('gtk_doc') and get_option('introspection') ) gweather_content_files = [ + 'migrating-3to4.md', ] custom_target('libgweather-doc', diff --git a/doc/migrating-3to4.md b/doc/migrating-3to4.md new file mode 100644 index 0000000..b067061 --- /dev/null +++ b/doc/migrating-3to4.md @@ -0,0 +1,13 @@ +Title: Migrating from GWeather 3.x to GWeather 4 + +## Migrating from GWeather 3.x to GWeather 4 + +GWeather 4 is a new major version that breaks API and ABI compared with +GWeather 3. + +### Stop using `GWeatherLocationEntry` and `GWeatherTimezoneMenu` + +GWeather 4 does not provide GTK widgets for selecting a location or a time +zone. Applications should provide their own UI, if needed, according to the +best practices of the [GNOME human interface +guidelines](https://developer.gnome.org/hig/). |