[py] Fix formatting issues in API reference (#12137)

tess-lu · web-flow · commit 1047de3dae05 · 2023-06-03T13:17:29.000+02:00
diff --git a/py/docs/source/common/selenium.common.exceptions.rst b/py/docs/source/common/selenium.common.exceptions.rst
@@ -45,6 +45,7 @@
       NoSuchShadowRootException
       NoSuchWindowException
       ScreenshotException
+      SeleniumManagerException
       SessionNotCreatedException
       StaleElementReferenceException
       TimeoutException
diff --git a/py/selenium/webdriver/chromium/webdriver.py b/py/selenium/webdriver/chromium/webdriver.py
@@ -112,6 +112,7 @@ def set_permissions(self, name: str, value: str) -> None:
 
         :Usage:
             ::
+
                 driver.set_permissions('clipboard-read', 'denied')
         """
         self.execute("setPermissions", {"descriptor": {"name": name}, "state": value})
@@ -127,6 +128,7 @@ def execute_cdp_cmd(self, cmd: str, cmd_args: dict):
          - cmd_args: A dict, command args. empty dict {} if there is no command args
         :Usage:
             ::
+
                 driver.execute_cdp_cmd('Network.getResponseBody', {'requestId': requestId})
         :Returns:
             A dict, empty dict {} if there is no result to return.
diff --git a/py/selenium/webdriver/common/alert.py b/py/selenium/webdriver/common/alert.py
@@ -32,14 +32,14 @@ class Alert:
         Alert(driver).accept()
         Alert(driver).dismiss()
 
-    Inputting a value into an alert prompt:
+    Inputting a value into an alert prompt::
 
         name_prompt = Alert(driver)
         name_prompt.send_keys("Willian Shakesphere")
         name_prompt.accept()
 
 
-    Reading a the text of a prompt for verification:
+    Reading a the text of a prompt for verification::
 
         alert_text = Alert(driver).text
         self.assertEqual("Do you wish to quit?", alert_text)
@@ -65,8 +65,10 @@ def dismiss(self):
     def accept(self):
         """Accepts the alert available.
 
-        Usage::
-        Alert(driver).accept() # Confirm a alert dialog.
+        :Usage:
+            ::
+
+                Alert(driver).accept() # Confirm a alert dialog.
         """
         self.driver.execute(Command.W3C_ACCEPT_ALERT)
 
diff --git a/py/selenium/webdriver/remote/webdriver.py b/py/selenium/webdriver/remote/webdriver.py
@@ -224,10 +224,10 @@ def file_detector_context(self, file_detector_class, *args, **kwargs):
         """Overrides the current file detector (if necessary) in limited
         context. Ensures the original file detector is set afterwards.
 
-        Example:
+        Example::
 
-        with webdriver.file_detector_context(UselessFileDetector):
-            someinput.send_keys('/etc/hosts')
+            with webdriver.file_detector_context(UselessFileDetector):
+                someinput.send_keys('/etc/hosts')
 
         :Args:
          - file_detector_class - Class of the desired file detector. If the class is different
@@ -620,11 +620,13 @@ def add_cookie(self, cookie_dict) -> None:
          - cookie_dict: A dictionary object, with required keys - "name" and "value";
             optional keys - "path", "domain", "secure", "httpOnly", "expiry", "sameSite"
 
-        Usage:
-            driver.add_cookie({'name' : 'foo', 'value' : 'bar'})
-            driver.add_cookie({'name' : 'foo', 'value' : 'bar', 'path' : '/'})
-            driver.add_cookie({'name' : 'foo', 'value' : 'bar', 'path' : '/', 'secure':True})
-            driver.add_cookie({'name': 'foo', 'value': 'bar', 'sameSite': 'Strict'})
+        :Usage:
+            ::
+
+                driver.add_cookie({'name' : 'foo', 'value' : 'bar'})
+                driver.add_cookie({'name' : 'foo', 'value' : 'bar', 'path' : '/'})
+                driver.add_cookie({'name' : 'foo', 'value' : 'bar', 'path' : '/', 'secure' : True})
+                driver.add_cookie({'name' : 'foo', 'value' : 'bar', 'sameSite' : 'Strict'})
         """
         if "sameSite" in cookie_dict:
             assert cookie_dict["sameSite"] in ["Strict", "Lax", "None"]
@@ -686,6 +688,7 @@ def timeouts(self) -> Timeouts:
 
         :Usage:
             ::
+
                 driver.timeouts
         :rtype: Timeout
         """
