update docs

thunderbird · Dec 8, 2023 · 0a71580 · 0a71580
1 parent 2baeece
commit 0a71580
Show file tree

Hide file tree

Showing 25 changed files with 62 additions and 28 deletions.
diff --git a/accounts.rst b/accounts.rst
@@ -6,8 +6,9 @@
   * `Functions`_
   * `Events`_
   * `Types`_
+  * `Examples`_
 
-  .. include:: /developer-resources.rst
+  .. include:: /overlay/developer-resources.rst
 
   ≡ Related information
 
@@ -401,3 +402,12 @@ An object describing a mail account, as returned for example by the :ref:`accoun
 
       The folders for this account are only included if requested.
 
+
+
+.. rst-class:: examples
+
+Examples
+========
+
+
+.. include:: /examples/accounts.rst
diff --git a/addressBooks.provider.rst b/addressBooks.provider.rst
@@ -5,7 +5,7 @@
   * `Permissions`_
   * `Events`_
 
-  .. include:: /developer-resources.rst
+  .. include:: /overlay/developer-resources.rst
 
   ≡ Related information
 

diff --git a/addressBooks.rst b/addressBooks.rst
@@ -7,12 +7,15 @@
   * `Events`_
   * `Types`_
 
-  .. include:: /developer-resources.rst
+  .. include:: /overlay/developer-resources.rst
 
   ≡ Related information
 
   * :doc:`/how-to/contacts`
   * :doc:`/how-to/eventListeners`
+
+  ≡ Related examples on Github
+
   * `"Address Book" example <https://github.com/thunderbird/sample-extensions/tree/master/manifest_v2/addressBooks>`__
 
 ================

diff --git a/browserAction.rst b/browserAction.rst
@@ -8,7 +8,7 @@
   * `Types`_
   * `External Types`_
 
-  .. include:: /developer-resources.rst
+  .. include:: /overlay/developer-resources.rst
 
 =================
 browserAction API

diff --git a/cloudFile.rst b/cloudFile.rst
@@ -7,11 +7,14 @@
   * `Events`_
   * `Types`_
 
-  .. include:: /developer-resources.rst
+  .. include:: /overlay/developer-resources.rst
 
   ≡ Related information
 
   * :doc:`/how-to/eventListeners`
+
+  ≡ Related examples on Github
+
   * `"DropBox Uploader" example <https://github.com/thunderbird/sample-extensions/tree/master/manifest_v2/dropbox>`__
 
 =============

diff --git a/commands.rst b/commands.rst
@@ -7,7 +7,7 @@
   * `Events`_
   * `Types`_
 
-  .. include:: /developer-resources.rst
+  .. include:: /overlay/developer-resources.rst
 
   ≡ Related information
 

diff --git a/compose.rst b/compose.rst
@@ -7,11 +7,14 @@
   * `Events`_
   * `Types`_
 
-  .. include:: /developer-resources.rst
+  .. include:: /overlay/developer-resources.rst
 
   ≡ Related information
 
   * :doc:`/how-to/eventListeners`
+
+  ≡ Related examples on Github
+
   * `"Compose Body" example <https://github.com/thunderbird/sample-extensions/tree/master/manifest_v2/composeBody>`__
 
 ===========

diff --git a/composeAction.rst b/composeAction.rst
@@ -8,7 +8,7 @@
   * `Types`_
   * `External Types`_
 
-  .. include:: /developer-resources.rst
+  .. include:: /overlay/developer-resources.rst
 
   ≡ Related information
 

diff --git a/composeScripts.rst b/composeScripts.rst
@@ -7,7 +7,7 @@
   * `Types`_
   * `External Types`_
 
-  .. include:: /developer-resources.rst
+  .. include:: /overlay/developer-resources.rst
 
 ==================
 composeScripts API

diff --git a/contacts.rst b/contacts.rst
@@ -7,12 +7,15 @@
   * `Events`_
   * `Types`_
 
-  .. include:: /developer-resources.rst
+  .. include:: /overlay/developer-resources.rst
 
   ≡ Related information
 
   * :doc:`/how-to/contacts`
   * :doc:`/how-to/eventListeners`
+
+  ≡ Related examples on Github
+
   * `"Address Book" example <https://github.com/thunderbird/sample-extensions/tree/master/manifest_v2/addressBooks>`__
 
 ============

diff --git a/folders.rst b/folders.rst
@@ -7,7 +7,7 @@
   * `Events`_
   * `Types`_
 
-  .. include:: /developer-resources.rst
+  .. include:: /overlay/developer-resources.rst
 
   ≡ Related information
 

diff --git a/identities.rst b/identities.rst
@@ -7,7 +7,7 @@
   * `Events`_
   * `Types`_
 
-  .. include:: /developer-resources.rst
+  .. include:: /overlay/developer-resources.rst
 
   ≡ Related information
 

diff --git a/mailTabs.rst b/mailTabs.rst
@@ -6,11 +6,14 @@
   * `Events`_
   * `Types`_
 
-  .. include:: /developer-resources.rst
+  .. include:: /overlay/developer-resources.rst
 
   ≡ Related information
 
   * :doc:`/how-to/eventListeners`
+
+  ≡ Related examples on Github
+
   * `"Quickfilter" example <https://github.com/thunderbird/sample-extensions/tree/master/manifest_v2/quickfilter>`__
   * `"MailTab Layout" example <https://github.com/thunderbird/sample-extensions/tree/master/manifest_v2/mailtabs>`__
 

diff --git a/mailingLists.rst b/mailingLists.rst
@@ -7,12 +7,15 @@
   * `Events`_
   * `Types`_
 
-  .. include:: /developer-resources.rst
+  .. include:: /overlay/developer-resources.rst
 
   ≡ Related information
 
   * :doc:`/how-to/contacts`
   * :doc:`/how-to/eventListeners`
+
+  ≡ Related examples on Github
+
   * `"Address Book" example <https://github.com/thunderbird/sample-extensions/tree/master/manifest_v2/addressBooks>`__
 
 ================

diff --git a/menus.rst b/menus.rst
@@ -9,11 +9,14 @@
   * `External Types`_
   * `Properties`_
 
-  .. include:: /developer-resources.rst
+  .. include:: /overlay/developer-resources.rst
 
   ≡ Related information
 
   * :doc:`/how-to/eventListeners`
+
+  ≡ Related examples on Github
+
   * `"Quickfilter" example <https://github.com/thunderbird/sample-extensions/tree/master/manifest_v2/quickfilter>`__
   * `"Menu" example <https://github.com/thunderbird/sample-extensions/tree/master/manifest_v2/menu>`__
 

diff --git a/messageDisplay.rst b/messageDisplay.rst
@@ -5,9 +5,9 @@
   * `Functions`_
   * `Events`_
 
-  .. include:: /developer-resources.rst
+  .. include:: /overlay/developer-resources.rst
 
-  ≡ Related information
+  ≡ Related examples on Github
 
   * `"Message Display" example <https://github.com/thunderbird/sample-extensions/tree/master/manifest_v2/messageDisplay>`__
 

diff --git a/messageDisplayAction.rst b/messageDisplayAction.rst
@@ -8,9 +8,9 @@
   * `Types`_
   * `External Types`_
 
-  .. include:: /developer-resources.rst
+  .. include:: /overlay/developer-resources.rst
 
-  ≡ Related information
+  ≡ Related examples on Github
 
   * `"Message Display" example <https://github.com/thunderbird/sample-extensions/tree/master/manifest_v2/messageDisplay>`__
 

diff --git a/messageDisplayScripts.rst b/messageDisplayScripts.rst
@@ -7,9 +7,9 @@
   * `Types`_
   * `External Types`_
 
-  .. include:: /developer-resources.rst
+  .. include:: /overlay/developer-resources.rst
 
-  ≡ Related information
+  ≡ Related examples on Github
 
   * `"Inline Attachment Preview" example <https://github.com/thunderbird/sample-extensions/tree/master/manifest_v2/messageDisplayScript.pdfPreview>`__
   * `"Notification Banner" example <https://github.com/thunderbird/sample-extensions/tree/master/manifest_v2/messageDisplayScript.pdfPreview>`__

diff --git a/messages.rst b/messages.rst
@@ -7,7 +7,7 @@
   * `Events`_
   * `Types`_
 
-  .. include:: /developer-resources.rst
+  .. include:: /overlay/developer-resources.rst
 
   ≡ Related information
 

diff --git a/sessions.rst b/sessions.rst
@@ -4,7 +4,7 @@
 
   * `Functions`_
 
-  .. include:: /developer-resources.rst
+  .. include:: /overlay/developer-resources.rst
 
 ============
 sessions API

diff --git a/spaces.rst b/spaces.rst
@@ -6,7 +6,7 @@
   * `Types`_
   * `External Types`_
 
-  .. include:: /developer-resources.rst
+  .. include:: /overlay/developer-resources.rst
 
 ==========
 spaces API

diff --git a/spacesToolbar.rst b/spacesToolbar.rst
@@ -6,7 +6,7 @@
   * `Types`_
   * `External Types`_
 
-  .. include:: /developer-resources.rst
+  .. include:: /overlay/developer-resources.rst
 
 =============
 spacesToolbar

diff --git a/tabs.rst b/tabs.rst
@@ -8,7 +8,7 @@
   * `Types`_
   * `Properties`_
 
-  .. include:: /developer-resources.rst
+  .. include:: /overlay/developer-resources.rst
 
   ≡ Related information
 

diff --git a/theme.rst b/theme.rst
@@ -9,7 +9,7 @@
   * `Types`_
   * `External Types`_
 
-  .. include:: /developer-resources.rst
+  .. include:: /overlay/developer-resources.rst
 
   ≡ Related information
 

diff --git a/windows.rst b/windows.rst
@@ -7,11 +7,14 @@
   * `Types`_
   * `Properties`_
 
-  .. include:: /developer-resources.rst
+  .. include:: /overlay/developer-resources.rst
 
   ≡ Related information
 
   * :doc:`/how-to/eventListeners`
+
+  ≡ Related examples on Github
+
   * `"Await Popup" example <https://github.com/thunderbird/sample-extensions/tree/master/manifest_v2/awaitPopup>`__
 
 ===========