docs: add other modules to docs generation

Author: Salakar

docs/generate.sh

@@ -82,7 +82,7 @@ if [[ "$OUTDIR" == "" ]]; then
 fi
 
 TITLE="Firebase Python SDK for Cloud Functions"
-PY_MODULES='firebase_functions firebase_functions.core firebase_functions.https firebase_functions.params firebase_functions.db'
+PY_MODULES='firebase_functions firebase_functions.core firebase_functions.https firebase_functions.params firebase_functions.db firebase_functions.options firebase_functions.pubsub firebase_functions.storage'
 DEVSITE_PATH='/docs/reference/functions-python'
 
 #

src/firebase_functions/options.py

@@ -377,7 +377,7 @@ class DatabaseOptions(RuntimeOptions):
     """
     Specify the handler to trigger on a database instance(s).
     If present, this value can either be a single instance or a pattern.
-    Examples: 'my-instance-1', 'my-instance-*'
+    Examples: 'my-instance-1', 'my-instance-\\*'
     Note: The capture syntax cannot be used for 'instance'.
     """
 

src/firebase_functions/pubsub.py

@@ -157,7 +157,11 @@ def _message_handler(
 def on_message_published(**kwargs) -> _typing.Callable[[_C1], _C1]:
     """
     Event handler which triggers on a message being published to a Pub/Sub topic.
-    Example::
+
+    Example:
+
+    .. code-block:: python
+
       @on_message_published(topic="hello-world")
       def example(event: CloudEvent[MessagePublishedData[object]]) -> None:
           pass

src/firebase_functions/storage.py

@@ -266,7 +266,10 @@ def on_object_archived(**kwargs) -> _typing.Callable[[_C1], _C1]:
     archived version, either because it was archived or because it was
     overwritten by the upload of an object of the same name.
 
-    Example::
+    Example:
+
+    .. code-block:: python
+
       @on_object_archived()
       def example(event: CloudEvent[StorageObjectData]) -> None:
           pass
@@ -299,7 +302,10 @@ def on_object_finalized(**kwargs) -> _typing.Callable[[_C1], _C1]:
     is successfully created in the bucket. This includes copying or rewriting
     an existing object. A failed upload does not trigger this event.
 
-    Example::
+    Example:
+
+    .. code-block:: python
+
       @on_object_finalized()
       def example(event: CloudEvent[StorageObjectData]) -> None:
           pass
@@ -333,7 +339,10 @@ def on_object_deleted(**kwargs) -> _typing.Callable[[_C1], _C1]:
     sent when an object is archived, even if archival occurs
     via the `storage.objects.delete` method.
 
-    Example::
+    Example:
+
+    .. code-block:: python
+
       @on_object_deleted()
       def example(event: CloudEvent[StorageObjectData]) -> None:
           pass
@@ -363,7 +372,10 @@ def on_object_metadata_updated(**kwargs) -> _typing.Callable[[_C1], _C1]:
     Event handler which fires every time the metadata of an existing object
     changes.
 
-    Example::
+    Example:
+
+    .. code-block:: python
+
       @on_object_metadata_updated()
       def example(event: CloudEvent[StorageObjectData]) -> None:
           pass