[gi-docgen/ebassi/related-libraries: 1/3] config: Add "related" configuration key




commit 86ed8c62b50b53091b8d15ce426bfc9b0345dbf2
Author: Emmanuele Bassi <ebassi gnome org>
Date:   Sat Feb 12 16:37:11 2022 +0000

    config: Add "related" configuration key
    
    Related libraries should not be included in the "dependencies"
    configuration.

 gidocgen/config.py | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
---
diff --git a/gidocgen/config.py b/gidocgen/config.py
index 58fdec8..1e00316 100644
--- a/gidocgen/config.py
+++ b/gidocgen/config.py
@@ -107,6 +107,24 @@ class GIDocConfig:
 
         return retval
 
+    @property
+    def related(self):
+        library = self._config.get('library', None)
+        if library is None:
+            return {}
+
+        retval = {}
+        dependencies = self._config.get('related', {})
+        for gir_name, dep in dependencies.items():
+            res = {}
+            res['name'] = dep.get('name', 'Unknown')
+            res['description'] = dep.get('description', 'No description provided')
+            res['docs_url'] = dep.get('docs_url', '#')
+            retval[gir_name] = res
+            log.debug(f"Found related library {gir_name}: {res}")
+
+        return retval
+
     @property
     def devhelp(self):
         return self.library.get('devhelp', False)


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]