浏览代码

Fixing RST render issue (hopefully)

Jonny Wenmoth 11 年之前
父节点
当前提交
994e07d815
共有 2 个文件被更改,包括 16 次插入17 次删除
  1. 1 0
      README.md
  2. 15 17
      doc/troubleshooting.rst

+ 1 - 0
README.md

@@ -18,6 +18,7 @@ Feature List
 * View javascript console errors
 * View javascript console errors
 * View detailed PhantomJS debuged information
 * View detailed PhantomJS debuged information
 * Save screen captures to local disk 
 * Save screen captures to local disk 
+* Set viewport size
 * Define screen capture x, y, width and height parameters
 * Define screen capture x, y, width and height parameters
 * Delay page rendering for a specified time
 * Delay page rendering for a specified time
 * Execute PhantomJS with command line options
 * Execute PhantomJS with command line options

+ 15 - 17
doc/troubleshooting.rst

@@ -3,11 +3,11 @@ Troubleshooting
 
 
 -  `It's not installing anything to my bin
 -  `It's not installing anything to my bin
    directory <#its-not-installing-anything-to-my-bin-directory>`__
    directory <#its-not-installing-anything-to-my-bin-directory>`__
--  `I am getting a InvalidExecutableException when making a
+-  `I am getting a ``InvalidExecutableException`` when making a
    request <#i-am-getting-a-invalidexecutableexception-when-making-a-request>`__
    request <#i-am-getting-a-invalidexecutableexception-when-making-a-request>`__
--  `I am getting a NotWritableException when making a
+-  `I am getting a ``NotWritableException`` when making a
    request <#i-am-getting-a-notwritableexception-when-making-a-request>`__
    request <#i-am-getting-a-notwritableexception-when-making-a-request>`__
--  `Why do I need the phantomloader
+-  `Why do I need the ``phantomloader``
    file? <#why-do-i-need-the-phantomloader-file>`__
    file? <#why-do-i-need-the-phantomloader-file>`__
 -  `Why am I getting a status code of 0 in the
 -  `Why am I getting a status code of 0 in the
    response? <#why-am-i-getting-a-status-code-of-0-in-the-response>`__
    response? <#why-am-i-getting-a-status-code-of-0-in-the-response>`__
@@ -15,11 +15,11 @@ Troubleshooting
 -  `Can I set the screenshot size? <#can-i-set-the-screenshot-size>`__
 -  `Can I set the screenshot size? <#can-i-set-the-screenshot-size>`__
 -  `Can I set the viewport size? <#can-i-set-the-viewport-size>`__
 -  `Can I set the viewport size? <#can-i-set-the-viewport-size>`__
 -  `How to I debug a request? <#how-to-i-debug-a-request>`__
 -  `How to I debug a request? <#how-to-i-debug-a-request>`__
--  `I am getting SyntaxError: Parse error in the debug
+-  `I am getting ``SyntaxError: Parse error`` in the debug
    log <#i-am-getting-syntaxerror-parse-error-in-the-debug-log>`__
    log <#i-am-getting-syntaxerror-parse-error-in-the-debug-log>`__
 
 
 It's not installing anything to my bin directory
 It's not installing anything to my bin directory
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 
 When installing via composer, as outlined in the `installation
 When installing via composer, as outlined in the `installation
 guide <https://github.com/jonnnnyw/php-phantomjs/blob/master/doc/installation.html>`__, it is recommended
 guide <https://github.com/jonnnnyw/php-phantomjs/blob/master/doc/installation.html>`__, it is recommended
@@ -52,9 +52,7 @@ This should install 2 files to your bin folder: ``phantomjs`` and
 ``phantomloader``. If you do not have these 2 files in your bin folder
 ``phantomloader``. If you do not have these 2 files in your bin folder
 then check that the folder is writable and run composer install again.
 then check that the folder is writable and run composer install again.
 
 
-    Note
-    ^^^^
-
+.. important::
     If you do not define a bin directory in your ``composer.json`` file
     If you do not define a bin directory in your ``composer.json`` file
     then the default install location will be ``vendor/bin/``. If you
     then the default install location will be ``vendor/bin/``. If you
     choose to not set a bin folder path then you will need to make sure
     choose to not set a bin folder path then you will need to make sure
@@ -62,7 +60,7 @@ then check that the folder is writable and run composer install again.
     ``$client->setBinDir('vendor/bin');`` before making a request.
     ``$client->setBinDir('vendor/bin');`` before making a request.
 
 
 I am getting a ``InvalidExecutableException`` when making a request
 I am getting a ``InvalidExecutableException`` when making a request
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 
 If you have installed via composer, as outlined in the `installation
 If you have installed via composer, as outlined in the `installation
 guide <https://github.com/jonnnnyw/php-phantomjs/blob/master/doc/installation.html>`__, then you should
 guide <https://github.com/jonnnnyw/php-phantomjs/blob/master/doc/installation.html>`__, then you should
@@ -91,7 +89,7 @@ request:
         $client->setBinDir('/path/to/bin/dir');
         $client->setBinDir('/path/to/bin/dir');
 
 
 I am getting a ``NotWritableException`` when making a request
 I am getting a ``NotWritableException`` when making a request
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 
 When making a request, the PHP PhantomJS library compiles a temporary
 When making a request, the PHP PhantomJS library compiles a temporary
 script file to your system's tmp folder. The location of this folder is
 script file to your system's tmp folder. The location of this folder is
@@ -100,7 +98,7 @@ this directory is not writable by your application then you will receive
 this exception.
 this exception.
 
 
 Why do I need the ``phantomloader`` file?
 Why do I need the ``phantomloader`` file?
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 
 A proxy loader file is used get around a quirk that PhantomJS has when
 A proxy loader file is used get around a quirk that PhantomJS has when
 it encounters a syntax error in a script file. By default, if PhantomJS
 it encounters a syntax error in a script file. By default, if PhantomJS
@@ -123,7 +121,7 @@ screenshots. See `It's not saving my
 screenshots <#its-not-saving-my-screenshots>`__.
 screenshots <#its-not-saving-my-screenshots>`__.
 
 
 Why am I getting a status code of 0 in the response?
 Why am I getting a status code of 0 in the response?
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 
 A status code of 0 in the response object generally means the request
 A status code of 0 in the response object generally means the request
 did not complete successfully. This could mean that the URL you are
 did not complete successfully. This could mean that the URL you are
@@ -239,7 +237,7 @@ instead of ``success``, chances are the URL you are requesting is
 invalid or not resolving.
 invalid or not resolving.
 
 
 It's not saving my screenshots
 It's not saving my screenshots
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 
 When making a capture request you need to make sure that you are setting
 When making a capture request you need to make sure that you are setting
 the file location that you want the screenshot saved to, including the
 the file location that you want the screenshot saved to, including the
@@ -268,7 +266,7 @@ has permissions to write files to the directory you are setting for your
 screen captures.
 screen captures.
 
 
 Can I set the screenshot size?
 Can I set the screenshot size?
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 
 Yes, you can set the width and height of your capture along with the x
 Yes, you can set the width and height of your capture along with the x
 and y coordinates of where the capture should start from:
 and y coordinates of where the capture should start from:
@@ -297,7 +295,7 @@ and y coordinates of where the capture should start from:
         $client->send($request, $response);
         $client->send($request, $response);
 
 
 Can I set the viewport size?
 Can I set the viewport size?
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 
 Yes, you can set the viewport dimensions on both regular and capture
 Yes, you can set the viewport dimensions on both regular and capture
 requests:
 requests:
@@ -321,7 +319,7 @@ requests:
         $client->send($request, $response);
         $client->send($request, $response);
 
 
 How to I debug a request?
 How to I debug a request?
-^^^^^^^^^^^^^^^^^^^^^^^^^
+~~~~~~~~~~~~~~~~~~~~~~~~~
 
 
 By setting the debug flag to ``true`` on the client, you can get a dump
 By setting the debug flag to ``true`` on the client, you can get a dump
 of information output from PhantomJS along with some info events added
 of information output from PhantomJS along with some info events added
@@ -362,7 +360,7 @@ from the URL you are calling, in the response object:
         var_dump($response->getConsole()); // Outputs array of console errors and stack trace
         var_dump($response->getConsole()); // Outputs array of console errors and stack trace
 
 
 I am getting ``SyntaxError: Parse error`` in the debug log
 I am getting ``SyntaxError: Parse error`` in the debug log
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 
 You will only get this error if the script file that is being run by
 You will only get this error if the script file that is being run by
 PhantomJS has a syntax error. If you are writing your own `custom
 PhantomJS has a syntax error. If you are writing your own `custom