From 88db532bf91a87149f860e982b3d8ef857111395 Mon Sep 17 00:00:00 2001 From: Daniel Mensinger Date: Sat, 9 Oct 2021 23:03:17 +0200 Subject: [PATCH] docs: Update docs --- docs/markdown/IDE-integration.md | 11 +++++++++++ docs/refman/templates/root.mustache | 10 ++++++++-- 2 files changed, 19 insertions(+), 2 deletions(-) diff --git a/docs/markdown/IDE-integration.md b/docs/markdown/IDE-integration.md index cf1c5c1df..e64eccfcc 100644 --- a/docs/markdown/IDE-integration.md +++ b/docs/markdown/IDE-integration.md @@ -405,6 +405,17 @@ of a node type or the removal of a key) are unlikely and will be announced in the release notes. +# JSON Reference manual + +In additional to the online [Reference manual](Reference-manual.md), Meson also +offers the manual as JSON file. The content of this file is generated from the +same source as the online documentation. The two versions are thus identical +in content. + +This JSON document is attached to every Meson release since *0.60.0*. The JSON +schema is defined by the class structure given in +[`jsonschema.py`](https://github.com/mesonbuild/meson/blob/master/docs/refman/jsonschema.py) + # Existing integrations - [Gnome Builder](https://wiki.gnome.org/Apps/Builder) diff --git a/docs/refman/templates/root.mustache b/docs/refman/templates/root.mustache index 3752a224a..c793b04b2 100644 --- a/docs/refman/templates/root.mustache +++ b/docs/refman/templates/root.mustache @@ -5,8 +5,14 @@ render-subpages: false # Reference manual -This is the root page of the Meson reference manual. All functions -and methods are documented in detail in the following subpages: +This is the root page of the online Meson reference manual. This +manual is also available in a more machine readable format as a +JSON documented attached to every release since *0.60.0*. See our +[IDE integration](IDE-integration.md) documentation for more +information. + +All functions and methods are documented in detail in the +following subpages: ## Elementary types