doc: add dual navigation buttons and cleanup some docstrings (#758)

amazon-braket · Nov 21, 2024 · 5cb4a31 · 5cb4a31
1 parent e6775d5
commit 5cb4a31
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 4 deletions.
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/src/braket/circuits/circuit.py b/src/braket/circuits/circuit.py
@@ -1537,9 +1537,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,