cleanups

Author: dbu

conf.py

@@ -147,7 +147,7 @@
 # The name of an image file (within the static path) to use as favicon of the
 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 # pixels large.
-#html_favicon = None
+html_favicon = 'favicon.ico'
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
@@ -300,6 +300,5 @@
 
 rst_epilog = """
 .. _PSR-7: http://www.php-fig.org/psr/psr-7
-.. _`client implementation`:
 .. _Composer: https://getcomposer.org
 """

development/code-of-conduct.rst

@@ -36,7 +36,7 @@ This Code of Conduct applies both within project spaces and in public spaces
 when an individual is representing the project or its community.
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting a project maintainer at [[email protected]](mailto:[email protected]). All
+reported by contacting a project maintainer at [email protected]. All
 complaints will be reviewed and investigated and will result in a response that
 is deemed necessary and appropriate to the circumstances. Maintainers are
 obligated to maintain confidentiality with regard to the reporter of an

development/contributing.rst

@@ -18,7 +18,7 @@ Security issues
 ---------------
 
 If you discover any security related issues,
-please contact us at [[email protected]](mailto:[email protected]) instead of submitting an issue on GitHub.
+please contact us at [email protected] instead of submitting an issue on GitHub.
 This allows us to fix the issue and release a security hotfix without publicly disclosing the vulnerability.
 
 
@@ -49,7 +49,7 @@ Then install the dependencies through Composer_:
     $ composer install
 
 Write code and tests. When you are ready, run the tests.
-(This is usually [PHPUnit](http://phpunit.de/) or [PHPSpec](http://phpspec.net/))
+(This is usually PHPUnit_ or PHPSpec_)
 
 .. code-block:: bash
 
@@ -112,6 +112,8 @@ License
 
 All of our packages are licensed under the :doc:`MIT license <license>`.
 
+.. _PHPUnit: http://phpunit.de/
+.. _PHPSpec: http://phpspec.net/
 .. _guidelines: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
 .. _create a pull request: https://help.github.com/articles/creating-a-pull-request/
 .. _semver: http://semver.org

docs/css/extra.css

@@ -0,0 +1,35 @@
+HTTPlug: HTTP client abstraction
+================================
+
+HTTPlug is an abstraction for HTTP clients. There are two main use cases:
+
+1. Usage in a project/application
+2. Usage in a reusable package
+
+In both cases, the ``Http\Client\HttpClient`` provides a ``sendRequest`` method
+to send a PSR-7 ``RequestInterface`` and returns a PSR-7 ``ResponseInterface``
+or throws an exception that implements ``Http\Client\Exception``.
+
+There is also the ``Http\Client\HttpAsyncClient`` which provides the
+``sendAsyncRequest`` method to send a request asynchronously and returns a
+``Http\Client\Promise``.
+
+The promise allows to specify handlers for a PSR-7 ``ResponseInterface``
+or an exception that implements ``Http\Client\Exception``.
+
+.. warning::
+
+    Contract for the ``Http\Promise\Promise`` is temporary until `PSR is released`_.
+    Once it is out, we will use this PSR in the main client and deprecate the old contract.
+
+See the :doc:``tutorial`` for a concrete example.
+
+
+.. toctree::
+
+   Introduction <httplug/introduction>
+   Tutorial <httplug/tutorial>
+   Migrating <httplug/migrating>
+   Virtual Package <httplug/virtual-package>
+
+.. _`PSR is released`: https://groups.google.com/forum/?fromgroups#!topic/php-fig/wzQWpLvNSjs

docs/promise.md

@@ -1,28 +1,5 @@
-HTTPlug: HTTP client abstraction
-================================
-
-HTTPlug is an abstraction for HTTP clients. There are two main use cases:
-
-1. Usage in a project/application
-2. Usage in a reusable package
-
-In both cases, the ``Http\Client\HttpClient`` provides a ``sendRequest`` method
-to send a PSR-7 ``RequestInterface`` and returns a PSR-7 ``ResponseInterface``
-or throws an exception that implements ``Http\Client\Exception``.
-
-There is also the ``Http\Client\HttpAsyncClient` which provides the
-``sendAsyncRequest`` method to send a request asynchronously and returns a
-``Http\Client\Promise``.
-
-The promise allows to specify handlers for a PSR-7 ``ResponseInterface``
-or an exception that implements ``Http\Client\Exception``.
-
-.. warning::
-
-    Contract for the ``Http\Promise\Promise`` is temporary until `PSR is released`_.
-    Once it is out, we will use this PSR in the main client and deprecate the old contract.
-
-See the :doc:``tutorial`` for a concrete example.
+Introduction to HTTPlug
+=======================
 
 HTTPlug implementations
 -----------------------
@@ -49,8 +26,7 @@ Check links above for the full list of implementations.
 Usage in an application
 -----------------------
 
-When writing an application, you need to require a concrete
-[implementation](https://packagist.org/providers/php-http/client-implementation).
+When writing an application, you need to require a concrete implementation_.
 
 See :doc:`virtual-package` for more information on the topic of working with HTTPlug implementations.
 
@@ -113,7 +89,7 @@ In 2015, a decision has been made to move the library to its own organization, s
 
 See :doc:`migrating` for a guide how to migrate your code from the Ivory adapter to HTTPlug.
 
-.. _`PSR is released`: https://groups.google.com/forum/?fromgroups#!topic/php-fig/wzQWpLvNSjs
+.. _implementation: https://packagist.org/providers/php-http/client-implementation
 .. _HttplugBundle: https://github.com/php-http/HttplugBundle
 .. _`Eric Geloen`: https://github.com/egeloen
 .. _`Ivory Http Adapter`: https://github.com/egeloen/ivory-http-adapter).

docs/favicon.ico favicon.ico

@@ -59,18 +59,14 @@ for discussion around a future HTTP client PSR.
 
 .. toctree::
     :hidden:
-    :maxdepth: 2
+    :maxdepth: 3
 
     PHP-HTTP <self>
 
 .. toctree::
    :hidden:
-   :caption: HTTPlug
 
-   Introduction <httplug/introduction>
-   Tutorial <httplug/tutorial>
-   Migrating <httplug/migrating>
-   Virtual package <httplug/virtual-package>
+   HTTPlug <httplug>
 
 .. toctree::
    :hidden:
@@ -90,6 +86,6 @@ for discussion around a future HTTP client PSR.
 
 .. toctree::
    :hidden:
-   :caption: Development
+   :caption: ---------
 
    development/index.rst

httplug.rst

@@ -84,7 +84,7 @@ WSSE
     $authentication = new Wsse('username', 'password');
 
 Query Params
-*************
+************
 
 ``http://api.example.com/endpoint?access_token=9zh987g86fg87gh978hg9g79``::
 
@@ -163,7 +163,9 @@ Implementing an authentication method is easy: only one method needs to be imple
         {
             // do something with the request
 
-            // keep in mind that the request is immutable - return the updated version of the request with the authentication information added to it.
+            // keep in mind that the request is immutable - return the updated
+            // version of the request with the authentication information added
+            // to it.
             return $request;
         }
     }