LukeIS: [python] adding phantomjs classes to be generated in the docs…

… for next release, updating a few pydocs in phantomjs/service, updating changelog r18156
nimeacuerdo · Nov 15, 2012 · 218ecf8 · 218ecf8
1 parent 3d07c44
commit 218ecf8
Show file tree

Hide file tree

Showing 5 changed files with 28 additions and 3 deletions.
diff --git a/py/CHANGES b/py/CHANGES
@@ -1,5 +1,9 @@
+Selenium 2.27 (yet to be released)
+* Added support for phantomjs / ghostdriver
+
 Selenium 2.26
 * Added location_when_scrolled_into_view - Bug 4357
+* Added new expected_conditions support module to be used with WebDriverWait
 
 Selenium 2.25
 * Jython 2.7 Support - Bug 3988

diff --git a/py/docs/source/api.rst b/py/docs/source/api.rst
@@ -76,6 +76,16 @@ Webdriver.ie
 
    selenium.webdriver.ie.webdriver
 
+Webdriver.phantomjs
+-------------------
+
+.. currentmodule:: selenium.webdriver.phantomjs
+.. autosummary::
+   :toctree: webdriver_phantomjs
+
+   selenium.webdriver.phantomjs.service
+   selenium.webdriver.phantomjs.webdriver
+
 Webdriver.remote
 ----------------
 

diff --git a/py/docs/source/webdriver_phantomjs/selenium.webdriver.phantomjs.service.rst b/py/docs/source/webdriver_phantomjs/selenium.webdriver.phantomjs.service.rst
@@ -0,0 +1,4 @@
+selenium.webdriver.phantomjs.service
+====================================
+
+.. automodule:: selenium.webdriver.phantomjs.service
diff --git a/py/docs/source/webdriver_phantomjs/selenium.webdriver.phantomjs.webdriver.rst b/py/docs/source/webdriver_phantomjs/selenium.webdriver.phantomjs.webdriver.rst
@@ -0,0 +1,4 @@
+selenium.webdriver.phantomjs.webdriver
+======================================
+
+.. automodule:: selenium.webdriver.phantomjs.webdriver
diff --git a/py/selenium/webdriver/phantomjs/service.py b/py/selenium/webdriver/phantomjs/service.py
@@ -29,8 +29,11 @@ def __init__(self, executable_path, ghostdriver_path, port=0, service_args=None)
         Creates a new instance of the Service
         
         :Args:
-         - executable_path : Path to the ChromeDriver
-         - port : Port the service is running on """
+         - executable_path : Path to PhantomJS binary
+         - ghostdriver_path : Path to ghostdriver/src/main.js
+         - port : Port the service is running on 
+         - service_args : A List of other command line options to pass to PhantomJS
+        """
 
         self.port = port
         self.path = executable_path
@@ -46,7 +49,7 @@ def __init__(self, executable_path, ghostdriver_path, port=0, service_args=None)
 
     def start(self):
         """
-        Starts the ChromeDriver Service. 
+        Starts PhantomJS with GhostDriver. 
         
         :Exceptions:
          - WebDriverException : Raised either when it can't start the service