Merge branch 'main' into ruff_test

amazon-braket · Nov 26, 2024 · 20aaeca · 20aaeca
2 parents 49bb44c + b378184
commit 20aaeca
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 6 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,17 @@
 # Changelog
 
+## v1.88.2.post0 (2024-11-25)
+
+### Documentation Changes
+
+ * add dual navigation buttons and cleanup some docstrings
+
+## v1.88.2 (2024-11-18)
+
+### Bug Fixes and Other Changes
+
+ * Pin cloudpickle==2.2.1
+
 ## v1.88.1 (2024-10-21)
 
 ### Bug Fixes and Other Changes

diff --git a/doc/conf.py b/doc/conf.py
@@ -19,18 +19,23 @@
 ]
 
 source_suffix = ".rst"
-master_doc = "index"
+root_doc = "index"
 
 autoclass_content = "both"
 autodoc_member_order = "bysource"
 default_role = "py:obj"
 
 html_theme = "sphinx_rtd_theme"
+html_theme_options = {
+    "prev_next_buttons_location": "both",
+}
 htmlhelp_basename = f"{project}doc"
 
 language = "en"
 
 napoleon_use_rtype = False
+napoleon_google_docstring = True
+napoleon_numpy_docstring = False
 
 apidoc_module_dir = "../src/braket"
 apidoc_output_dir = "_apidoc"

diff --git a/setup.py b/setup.py
@@ -33,7 +33,9 @@
         "backoff",
         "boltons",
         "boto3>=1.28.53",
-        "cloudpickle>=3",
+        # SageMaker pinned cloudpickle==2.2.1
+        # see https://github.com/aws/sagemaker-python-sdk/issues/4871
+        "cloudpickle==2.2.1",
         "nest-asyncio",
         "networkx",
         "numpy",

diff --git a/src/braket/_sdk/_version.py b/src/braket/_sdk/_version.py
@@ -15,4 +15,4 @@
 Version number (major.minor.patch[-label])
 """
 
-__version__ = "1.88.2.dev0"
+__version__ = "1.88.3.dev0"
diff --git a/src/braket/circuits/circuit.py b/src/braket/circuits/circuit.py
@@ -1523,9 +1523,9 @@ def to_unitary(self) -> np.ndarray:
             `qubit count` > 10.
 
         Returns:
-            np.ndarray: A numpy array with shape (2^qubit_count, 2^qubit_count) representing the
-            circuit as a unitary. For an empty circuit, an empty numpy array is returned
-            (`array([], dtype=complex)`)
+            np.ndarray: A numpy array with shape (2 :sup:`qubit_count`, 2 :sup:`qubit_count`)
+            representing the circuit as a unitary. For an empty circuit, an empty numpy array
+            is returned (`array([], dtype=complex)`)
 
         Raises:
             TypeError: If circuit is not composed only of `Gate` instances,