[gi-docgen/ebassi/related-libraries: 3/3] docs: Update the project configuration page
- From: Emmanuele Bassi <ebassi src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gi-docgen/ebassi/related-libraries: 3/3] docs: Update the project configuration page
- Date: Sat, 12 Feb 2022 16:43:00 +0000 (UTC)
commit 86e27357215b5afc9a45bf9286a39b28abe00b9e
Author: Emmanuele Bassi <ebassi gnome org>
Date: Sat Feb 12 16:42:26 2022 +0000
docs: Update the project configuration page
List the new constraint on the dependencies key, and the newly added
related key.
docs/project-configuration.rst | 14 ++++++++++++--
1 file changed, 12 insertions(+), 2 deletions(-)
---
diff --git a/docs/project-configuration.rst b/docs/project-configuration.rst
index 728a8d4..30d403c 100644
--- a/docs/project-configuration.rst
+++ b/docs/project-configuration.rst
@@ -51,10 +51,20 @@ The following keys are used, if found:
``description`` = ``s``
A short description of the library.
-``dependencies`` = ``dict(s, dict(s, s)``
+``dependencies`` = ``dict(s, dict(s, s))``
A dictionary of dependencies; each entry in the dictionary has a key in the
form of ``{namespace}-{version}``, and values in the form of a dictionary
- with the following keys: ``name``, ``description``, and ``docs_url``.
+ with the following keys: ``name``, ``description``, and ``docs_url``. Each
+ entry in the this dictionary can only describe a namespace included in the
+ introspection data; any other namespace listed here will be ignored. See
+ the ``related`` configuration below.
+
+``related`` = ``dict(s, dict(s, s))``
+ A dictionary of related namespaces; each entry in the dictionary has a key
+ in the form of ``{namespace}-{version}``, and values in the form of a
+ dictionary with the following keys: ``name``, ``description``, and
+ ``docs_url``. Each entry in this dictionary can describe a namespace that
+ is related to the project.
``devhelp`` = ``b``
Whether gi-docgen should generate a DevHelp file for the namespace.
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]