Update documentation with sidebar

thunderbird · Dec 1, 2023 · 3536ec5 · 3536ec5
1 parent 4ec3c2b
commit 3536ec5
Show file tree

Hide file tree

Showing 25 changed files with 376 additions and 21 deletions.
diff --git a/accounts.rst b/accounts.rst
@@ -1,4 +1,18 @@
+.. container:: sticky-sidebar
 
+  ≡ accounts API
+
+  * `Permissions`_
+  * `Functions`_
+  * `Events`_
+  * `Types`_
+
+  .. include:: /developer-resources.rst
+
+  ≡ Other relevant information
+
+  * :doc:`/how-to/eventListeners`
+
 ============
 accounts API
 ============

diff --git a/action.rst b/action.rst
@@ -1,3 +1,20 @@
+.. container:: sticky-sidebar
+
+  ≡ action API
+
+  * `Manifest file properties`_
+  * `Functions`_
+  * `Events`_
+  * `Types`_
+  * `External Types`_
+
+  .. include:: /developer-resources.rst
+
+  ≡ Other relevant information
+
+  * :doc:`/how-to/eventListeners`
+  * `"API List" example <https://github.com/thunderbird/sample-extensions/tree/master/manifest_v3/apiList>`__
+
 ==========
 action API
 ==========

diff --git a/addressBooks.provider.rst b/addressBooks.provider.rst
@@ -1,3 +1,17 @@
+.. container:: sticky-sidebar
+
+  ≡ addressBooks.provider API
+
+  * `Permissions`_
+  * `Events`_
+
+  .. include:: /developer-resources.rst
+
+  ≡ Other relevant information
+
+  * :doc:`/how-to/contacts`
+  * :doc:`/how-to/eventListeners`
+
 =========================
 addressBooks.provider API
 =========================

diff --git a/addressBooks.rst b/addressBooks.rst
@@ -1,13 +1,26 @@
+.. container:: sticky-sidebar
+
+  ≡ addressBooks API
+
+  * `Permissions`_
+  * `Functions`_
+  * `Events`_
+  * `Types`_
+
+  .. include:: /developer-resources.rst
+
+  ≡ Other relevant information
+
+  * :doc:`/how-to/contacts`
+  * :doc:`/how-to/eventListeners`
+  * `"Address Book" example <https://github.com/thunderbird/sample-extensions/tree/master/manifest_v3/addressBooks>`__
+
 ================
 addressBooks API
 ================
 
 The :doc:`addressBooks`, also including the :doc:`contacts` and :doc:`mailingLists` namespaces, first appeared in Thunderbird 64.
 
-The `Address Books`__ sample extension uses this API.
-
-__ https://github.com/thunderbird/sample-extensions/tree/master/addressBooks
-
 .. role:: permission
 
 .. role:: value

diff --git a/cloudFile.rst b/cloudFile.rst
@@ -1,13 +1,25 @@
+.. container:: sticky-sidebar
+
+  ≡ cloudFile API
+
+  * `Manifest file properties`_
+  * `Functions`_
+  * `Events`_
+  * `Types`_
+
+  .. include:: /developer-resources.rst
+
+  ≡ Other relevant information
+
+  * :doc:`/how-to/eventListeners`
+  * `"DropBox Uploader" example <https://github.com/thunderbird/sample-extensions/tree/master/manifest_v3/dropbox>`__
+
 =============
 cloudFile API
 =============
 
 The cloudFile (a.k.a. fileLink) API first appeared in Thunderbird 60. It allows to create a provider to store large attachments in the cloud instead of attaching them directly to the message.
 
-The `DropBox Uploader`__ sample extension uses this API.
-
-__ https://github.com/thunderbird/sample-extensions/tree/master/dropbox
-
 .. role:: permission
 
 .. role:: value

diff --git a/commands.rst b/commands.rst
@@ -1,3 +1,18 @@
+.. container:: sticky-sidebar
+
+  ≡ commands API
+
+  * `Manifest file properties`_
+  * `Functions`_
+  * `Events`_
+  * `Types`_
+
+  .. include:: /developer-resources.rst
+
+  ≡ Other relevant information
+
+  * :doc:`/how-to/eventListeners`
+
 ============
 commands API
 ============

diff --git a/compose.rst b/compose.rst
@@ -1,3 +1,19 @@
+.. container:: sticky-sidebar
+
+  ≡ compose API
+
+  * `Permissions`_
+  * `Functions`_
+  * `Events`_
+  * `Types`_
+
+  .. include:: /developer-resources.rst
+
+  ≡ Other relevant information
+
+  * :doc:`/how-to/eventListeners`
+  * `"Compose Body" example <https://github.com/thunderbird/sample-extensions/tree/master/manifest_v3/composeBody>`__
+
 ===========
 compose API
 ===========

diff --git a/composeAction.rst b/composeAction.rst
@@ -1,3 +1,19 @@
+.. container:: sticky-sidebar
+
+  ≡ composeAction API
+
+  * `Manifest file properties`_
+  * `Functions`_
+  * `Events`_
+  * `Types`_
+  * `External Types`_
+
+  .. include:: /developer-resources.rst
+
+  ≡ Other relevant information
+
+  * :doc:`/how-to/eventListeners`
+
 =================
 composeAction API
 =================

diff --git a/composeScripts.rst b/composeScripts.rst
@@ -1,3 +1,14 @@
+.. container:: sticky-sidebar
+
+  ≡ composeScripts API
+
+  * `Permissions`_
+  * `Functions`_
+  * `Types`_
+  * `External Types`_
+
+  .. include:: /developer-resources.rst
+
 ==================
 composeScripts API
 ==================

diff --git a/contacts.rst b/contacts.rst
@@ -1,13 +1,26 @@
+.. container:: sticky-sidebar
+
+  ≡ contacts API
+
+  * `Permissions`_
+  * `Functions`_
+  * `Events`_
+  * `Types`_
+
+  .. include:: /developer-resources.rst
+
+  ≡ Other relevant information
+
+  * :doc:`/how-to/contacts`
+  * :doc:`/how-to/eventListeners`
+  * `"Address Book" example <https://github.com/thunderbird/sample-extensions/tree/master/manifest_v3/addressBooks>`__
+
 ============
 contacts API
 ============
 
 The :doc:`addressBooks`, also including the :doc:`contacts` and :doc:`mailingLists` namespaces, first appeared in Thunderbird 64.
 
-The `Address Books`__ sample extension uses this API.
-
-__ https://github.com/thunderbird/sample-extensions/tree/master/addressBooks
-
 .. role:: permission
 
 .. role:: value

diff --git a/folders.rst b/folders.rst
@@ -1,3 +1,18 @@
+.. container:: sticky-sidebar
+
+  ≡ folders API
+
+  * `Permissions`_
+  * `Functions`_
+  * `Events`_
+  * `Types`_
+
+  .. include:: /developer-resources.rst
+
+  ≡ Other relevant information
+
+  * :doc:`/how-to/eventListeners`
+
 ===========
 folders API
 ===========

diff --git a/identities.rst b/identities.rst
@@ -1,3 +1,18 @@
+.. container:: sticky-sidebar
+
+  ≡ identities API
+
+  * `Permissions`_
+  * `Functions`_
+  * `Events`_
+  * `Types`_
+
+  .. include:: /developer-resources.rst
+
+  ≡ Other relevant information
+
+  * :doc:`/how-to/eventListeners`
+
 ==============
 identities API
 ==============

diff --git a/mailTabs.rst b/mailTabs.rst
@@ -1,14 +1,25 @@
+.. container:: sticky-sidebar
+
+  ≡ mailTabs API
+
+  * `Functions`_
+  * `Events`_
+  * `Types`_
+
+  .. include:: /developer-resources.rst
+
+  ≡ Other relevant information
+
+  * :doc:`/how-to/eventListeners`
+  * `"Quickfilter" example <https://github.com/thunderbird/sample-extensions/tree/master/manifest_v3/quickfilter>`__
+  * `"MailTab Layout" example <https://github.com/thunderbird/sample-extensions/tree/master/manifest_v3/mailtabs>`__
+
 ============
 mailTabs API
 ============
 
 The mailTabs API first appeared in Thunderbird 66 and allows to interact with Thunderbirds main mail window.
 
-The `Filter`__  and `Layout`__ sample extensions use this API.
-
-__ https://github.com/thunderbird/sample-extensions/tree/master/filter
-__ https://github.com/thunderbird/sample-extensions/tree/master/layout
-
 .. role:: permission
 
 .. role:: value

diff --git a/mailingLists.rst b/mailingLists.rst
@@ -1,13 +1,26 @@
+.. container:: sticky-sidebar
+
+  ≡ mailingLists API
+
+  * `Permissions`_
+  * `Functions`_
+  * `Events`_
+  * `Types`_
+
+  .. include:: /developer-resources.rst
+
+  ≡ Other relevant information
+
+  * :doc:`/how-to/contacts`
+  * :doc:`/how-to/eventListeners`
+  * `"Address Book" example <https://github.com/thunderbird/sample-extensions/tree/master/manifest_v3/addressBooks>`__
+
 ================
 mailingLists API
 ================
 
 The :doc:`addressBooks`, also including the :doc:`contacts` and :doc:`mailingLists` namespaces, first appeared in Thunderbird 64.
 
-The `Address Books`__ sample extension uses this API.
-
-__ https://github.com/thunderbird/sample-extensions/tree/master/addressBooks
-
 .. role:: permission
 
 .. role:: value

diff --git a/menus.rst b/menus.rst
@@ -1,3 +1,22 @@
+.. container:: sticky-sidebar
+
+  ≡ menus API
+
+  * `Permissions`_
+  * `Functions`_
+  * `Events`_
+  * `Types`_
+  * `External Types`_
+  * `Properties`_
+
+  .. include:: /developer-resources.rst
+
+  ≡ Other relevant information
+
+  * :doc:`/how-to/eventListeners`
+  * `"Quickfilter" example <https://github.com/thunderbird/sample-extensions/tree/master/manifest_v3/quickfilter>`__
+  * `"Menu" example <https://github.com/thunderbird/sample-extensions/tree/master/manifest_v2/menu>`__
+
 =========
 menus API
 =========

diff --git a/messageDisplay.rst b/messageDisplay.rst
@@ -1,3 +1,16 @@
+.. container:: sticky-sidebar
+
+  ≡ messageDisplay API
+
+  * `Functions`_
+  * `Events`_
+
+  .. include:: /developer-resources.rst
+
+  ≡ Other relevant information
+
+  * `"Message Display" example <https://github.com/thunderbird/sample-extensions/tree/master/manifest_v3/messageDisplay>`__
+
 ==================
 messageDisplay API
 ==================

diff --git a/messageDisplayAction.rst b/messageDisplayAction.rst
@@ -1,3 +1,19 @@
+.. container:: sticky-sidebar
+
+  ≡ messageDisplayAction API
+
+  * `Manifest file properties`_
+  * `Functions`_
+  * `Events`_
+  * `Types`_
+  * `External Types`_
+
+  .. include:: /developer-resources.rst
+
+  ≡ Other relevant information
+
+  * `"Message Display" example <https://github.com/thunderbird/sample-extensions/tree/master/manifest_v3/messageDisplay>`__
+
 ========================
 messageDisplayAction API
 ========================