docs: fix docs session

Source-Link: googleapis/synthtool@223f39e Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-python:latest@sha256:8244c1253becbaa533f48724a6348e4b92a10df4b4dfb66d87e615e633059bdf
googleapis · Apr 7, 2024 · 989bfa1 · 989bfa1
1 parent 1cc1ff7
commit 989bfa1
Show file tree

Hide file tree

Showing 9 changed files with 82 additions and 43 deletions.
diff --git a/.github/.OwlBot.lock.yaml b/.github/.OwlBot.lock.yaml
@@ -13,5 +13,5 @@
 # limitations under the License.
 docker:
   image: gcr.io/cloud-devrel-public-resources/owlbot-python:latest
-  digest: sha256:a8a80fc6456e433df53fc2a0d72ca0345db0ddefb409f1b75b118dfd1babd952
-# created: 2024-03-15T16:25:47.905264637Z
+  digest: sha256:8244c1253becbaa533f48724a6348e4b92a10df4b4dfb66d87e615e633059bdf
+# created: 2024-04-07T11:43:40.730565127Z
diff --git a/.github/auto-label.yaml b/.github/auto-label.yaml
@@ -13,3 +13,8 @@
 # limitations under the License.
 requestsize:
   enabled: true
+
+path:
+  pullrequest: true
+  paths:
+    samples: "samples"
diff --git a/.github/blunderbuss.yml b/.github/blunderbuss.yml
@@ -0,0 +1,17 @@
+# Blunderbuss config
+#
+# This file controls who is assigned for pull requests and issues.
+# Note: This file is autogenerated. To make changes to the assignee
+# team, please update `codeowner_team` in `.repo-metadata.json`.
+assign_issues:
+  - googleapis/api-bigtable googleapis/api-bigtable-partners
+
+assign_issues_by:
+  - labels:
+      - "samples"
+    to:
+      - googleapis/python-samples-reviewers
+      - googleapis/api-bigtable googleapis/api-bigtable-partners
+
+assign_prs:
+  - googleapis/api-bigtable googleapis/api-bigtable-partners
diff --git a/docs/summary_overview.md b/docs/summary_overview.md
@@ -0,0 +1,22 @@
+[
+This is a templated file. Adding content to this file may result in it being
+reverted. Instead, if you want to place additional content, create an
+"overview_content.md" file in `docs/` directory. The Sphinx tool will
+pick up on the content and merge the content.
+]: #
+
+# Cloud Bigtable API
+
+Overview of the APIs available for Cloud Bigtable API.
+
+## All entries
+
+Classes, methods and properties & attributes for
+Cloud Bigtable API.
+
+[classes](https://cloud.google.com/python/docs/reference/bigtable/latest/summary_class.html)
+
+[methods](https://cloud.google.com/python/docs/reference/bigtable/latest/summary_method.html)
+
+[properties and
+attributes](https://cloud.google.com/python/docs/reference/bigtable/latest/summary_property.html)
diff --git a/samples/hello/noxfile.py b/samples/hello/noxfile.py
@@ -160,7 +160,6 @@ def blacken(session: nox.sessions.Session) -> None:
 # format = isort + black
 #
 
-
 @nox.session
 def format(session: nox.sessions.Session) -> None:
     """
@@ -188,9 +187,7 @@ def _session_tests(
     session: nox.sessions.Session, post_install: Callable = None
 ) -> None:
     # check for presence of tests
-    test_list = glob.glob("**/*_test.py", recursive=True) + glob.glob(
-        "**/test_*.py", recursive=True
-    )
+    test_list = glob.glob("**/*_test.py", recursive=True) + glob.glob("**/test_*.py", recursive=True)
     test_list.extend(glob.glob("**/tests", recursive=True))
 
     if len(test_list) == 0:
@@ -212,7 +209,9 @@ def _session_tests(
 
     if os.path.exists("requirements-test.txt"):
         if os.path.exists("constraints-test.txt"):
-            session.install("-r", "requirements-test.txt", "-c", "constraints-test.txt")
+            session.install(
+                "-r", "requirements-test.txt", "-c", "constraints-test.txt"
+            )
         else:
             session.install("-r", "requirements-test.txt")
         with open("requirements-test.txt") as rtfile:
@@ -225,9 +224,9 @@ def _session_tests(
         post_install(session)
 
     if "pytest-parallel" in packages:
-        concurrent_args.extend(["--workers", "auto", "--tests-per-worker", "auto"])
+        concurrent_args.extend(['--workers', 'auto', '--tests-per-worker', 'auto'])
     elif "pytest-xdist" in packages:
-        concurrent_args.extend(["-n", "auto"])
+        concurrent_args.extend(['-n', 'auto'])
 
     session.run(
         "pytest",
@@ -257,7 +256,7 @@ def py(session: nox.sessions.Session) -> None:
 
 
 def _get_repo_root() -> Optional[str]:
-    """Returns the root folder of the project."""
+    """ Returns the root folder of the project. """
     # Get root of this repository. Assume we don't have directories nested deeper than 10 items.
     p = Path(os.getcwd())
     for i in range(10):

diff --git a/samples/snippets/data_client/noxfile.py b/samples/snippets/data_client/noxfile.py
@@ -1,4 +1,4 @@
-# Copyright 2024 Google LLC
+# Copyright 2019 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -160,7 +160,6 @@ def blacken(session: nox.sessions.Session) -> None:
 # format = isort + black
 #
 
-
 @nox.session
 def format(session: nox.sessions.Session) -> None:
     """
@@ -188,9 +187,7 @@ def _session_tests(
     session: nox.sessions.Session, post_install: Callable = None
 ) -> None:
     # check for presence of tests
-    test_list = glob.glob("**/*_test.py", recursive=True) + glob.glob(
-        "**/test_*.py", recursive=True
-    )
+    test_list = glob.glob("**/*_test.py", recursive=True) + glob.glob("**/test_*.py", recursive=True)
     test_list.extend(glob.glob("**/tests", recursive=True))
 
     if len(test_list) == 0:
@@ -212,7 +209,9 @@ def _session_tests(
 
     if os.path.exists("requirements-test.txt"):
         if os.path.exists("constraints-test.txt"):
-            session.install("-r", "requirements-test.txt", "-c", "constraints-test.txt")
+            session.install(
+                "-r", "requirements-test.txt", "-c", "constraints-test.txt"
+            )
         else:
             session.install("-r", "requirements-test.txt")
         with open("requirements-test.txt") as rtfile:
@@ -225,9 +224,9 @@ def _session_tests(
         post_install(session)
 
     if "pytest-parallel" in packages:
-        concurrent_args.extend(["--workers", "auto", "--tests-per-worker", "auto"])
+        concurrent_args.extend(['--workers', 'auto', '--tests-per-worker', 'auto'])
     elif "pytest-xdist" in packages:
-        concurrent_args.extend(["-n", "auto"])
+        concurrent_args.extend(['-n', 'auto'])
 
     session.run(
         "pytest",
@@ -257,7 +256,7 @@ def py(session: nox.sessions.Session) -> None:
 
 
 def _get_repo_root() -> Optional[str]:
-    """Returns the root folder of the project."""
+    """ Returns the root folder of the project. """
     # Get root of this repository. Assume we don't have directories nested deeper than 10 items.
     p = Path(os.getcwd())
     for i in range(10):

diff --git a/samples/snippets/deletes/noxfile.py b/samples/snippets/deletes/noxfile.py
@@ -160,7 +160,6 @@ def blacken(session: nox.sessions.Session) -> None:
 # format = isort + black
 #
 
-
 @nox.session
 def format(session: nox.sessions.Session) -> None:
     """
@@ -188,9 +187,7 @@ def _session_tests(
     session: nox.sessions.Session, post_install: Callable = None
 ) -> None:
     # check for presence of tests
-    test_list = glob.glob("**/*_test.py", recursive=True) + glob.glob(
-        "**/test_*.py", recursive=True
-    )
+    test_list = glob.glob("**/*_test.py", recursive=True) + glob.glob("**/test_*.py", recursive=True)
     test_list.extend(glob.glob("**/tests", recursive=True))
 
     if len(test_list) == 0:
@@ -212,7 +209,9 @@ def _session_tests(
 
     if os.path.exists("requirements-test.txt"):
         if os.path.exists("constraints-test.txt"):
-            session.install("-r", "requirements-test.txt", "-c", "constraints-test.txt")
+            session.install(
+                "-r", "requirements-test.txt", "-c", "constraints-test.txt"
+            )
         else:
             session.install("-r", "requirements-test.txt")
         with open("requirements-test.txt") as rtfile:
@@ -225,9 +224,9 @@ def _session_tests(
         post_install(session)
 
     if "pytest-parallel" in packages:
-        concurrent_args.extend(["--workers", "auto", "--tests-per-worker", "auto"])
+        concurrent_args.extend(['--workers', 'auto', '--tests-per-worker', 'auto'])
     elif "pytest-xdist" in packages:
-        concurrent_args.extend(["-n", "auto"])
+        concurrent_args.extend(['-n', 'auto'])
 
     session.run(
         "pytest",
@@ -257,7 +256,7 @@ def py(session: nox.sessions.Session) -> None:
 
 
 def _get_repo_root() -> Optional[str]:
-    """Returns the root folder of the project."""
+    """ Returns the root folder of the project. """
     # Get root of this repository. Assume we don't have directories nested deeper than 10 items.
     p = Path(os.getcwd())
     for i in range(10):

diff --git a/samples/snippets/filters/noxfile.py b/samples/snippets/filters/noxfile.py
@@ -160,7 +160,6 @@ def blacken(session: nox.sessions.Session) -> None:
 # format = isort + black
 #
 
-
 @nox.session
 def format(session: nox.sessions.Session) -> None:
     """
@@ -188,9 +187,7 @@ def _session_tests(
     session: nox.sessions.Session, post_install: Callable = None
 ) -> None:
     # check for presence of tests
-    test_list = glob.glob("**/*_test.py", recursive=True) + glob.glob(
-        "**/test_*.py", recursive=True
-    )
+    test_list = glob.glob("**/*_test.py", recursive=True) + glob.glob("**/test_*.py", recursive=True)
     test_list.extend(glob.glob("**/tests", recursive=True))
 
     if len(test_list) == 0:
@@ -212,7 +209,9 @@ def _session_tests(
 
     if os.path.exists("requirements-test.txt"):
         if os.path.exists("constraints-test.txt"):
-            session.install("-r", "requirements-test.txt", "-c", "constraints-test.txt")
+            session.install(
+                "-r", "requirements-test.txt", "-c", "constraints-test.txt"
+            )
         else:
             session.install("-r", "requirements-test.txt")
         with open("requirements-test.txt") as rtfile:
@@ -225,9 +224,9 @@ def _session_tests(
         post_install(session)
 
     if "pytest-parallel" in packages:
-        concurrent_args.extend(["--workers", "auto", "--tests-per-worker", "auto"])
+        concurrent_args.extend(['--workers', 'auto', '--tests-per-worker', 'auto'])
     elif "pytest-xdist" in packages:
-        concurrent_args.extend(["-n", "auto"])
+        concurrent_args.extend(['-n', 'auto'])
 
     session.run(
         "pytest",
@@ -257,7 +256,7 @@ def py(session: nox.sessions.Session) -> None:
 
 
 def _get_repo_root() -> Optional[str]:
-    """Returns the root folder of the project."""
+    """ Returns the root folder of the project. """
     # Get root of this repository. Assume we don't have directories nested deeper than 10 items.
     p = Path(os.getcwd())
     for i in range(10):

diff --git a/samples/snippets/reads/noxfile.py b/samples/snippets/reads/noxfile.py
@@ -160,7 +160,6 @@ def blacken(session: nox.sessions.Session) -> None:
 # format = isort + black
 #
 
-
 @nox.session
 def format(session: nox.sessions.Session) -> None:
     """
@@ -188,9 +187,7 @@ def _session_tests(
     session: nox.sessions.Session, post_install: Callable = None
 ) -> None:
     # check for presence of tests
-    test_list = glob.glob("**/*_test.py", recursive=True) + glob.glob(
-        "**/test_*.py", recursive=True
-    )
+    test_list = glob.glob("**/*_test.py", recursive=True) + glob.glob("**/test_*.py", recursive=True)
     test_list.extend(glob.glob("**/tests", recursive=True))
 
     if len(test_list) == 0:
@@ -212,7 +209,9 @@ def _session_tests(
 
     if os.path.exists("requirements-test.txt"):
         if os.path.exists("constraints-test.txt"):
-            session.install("-r", "requirements-test.txt", "-c", "constraints-test.txt")
+            session.install(
+                "-r", "requirements-test.txt", "-c", "constraints-test.txt"
+            )
         else:
             session.install("-r", "requirements-test.txt")
         with open("requirements-test.txt") as rtfile:
@@ -225,9 +224,9 @@ def _session_tests(
         post_install(session)
 
     if "pytest-parallel" in packages:
-        concurrent_args.extend(["--workers", "auto", "--tests-per-worker", "auto"])
+        concurrent_args.extend(['--workers', 'auto', '--tests-per-worker', 'auto'])
     elif "pytest-xdist" in packages:
-        concurrent_args.extend(["-n", "auto"])
+        concurrent_args.extend(['-n', 'auto'])
 
     session.run(
         "pytest",
@@ -257,7 +256,7 @@ def py(session: nox.sessions.Session) -> None:
 
 
 def _get_repo_root() -> Optional[str]:
-    """Returns the root folder of the project."""
+    """ Returns the root folder of the project. """
     # Get root of this repository. Assume we don't have directories nested deeper than 10 items.
     p = Path(os.getcwd())
     for i in range(10):