Tweak installation instructions

pipsi ftw

Author: hynek

README.rst

@@ -16,7 +16,7 @@ doc2dash: Create docsets for Dash.app and clones
 .. begin
 
 
-``doc2dash`` is an MIT-licensed extensible `Documentation Set`_ generator intended to be used with the `Dash.app`_ API browser for OS X or one of its many :ref:`clones <clones>`.
+``doc2dash`` is an MIT-licensed extensible `Documentation Set`_ generator intended to be used with the `Dash.app`_ API browser for OS X or one of its many clones.
 
 If you’ve never heard of Dash.app, you’re missing out:
 Together with ``doc2dash`` it’s all your API documentation at your fingertips!

docs/formats.rst

@@ -0,0 +1,15 @@
+Supported Input Formats
+=======================
+
+Currently, the following input formats are supported:
+
+- Sphinx_’s HTML output (nearly every single Python project out there)
+- pydoctor_’s HTML output (Twisted_!)
+
+Feel free to help adding more! While ``doc2dash`` is implemented in Python, the scope for the supported documentation types is unlimited.
+So go on and submit a parser for your favourite Ruby, Haskell, Lisp, Erlang, JavaScript, …  format!
+
+
+.. _Twisted: https://twistedmatrix.com/
+.. _pydoctor: https://launchpad.net/pydoctor
+.. _Sphinx:  http://sphinx-doc.org/

docs/index.rst

@@ -1,5 +1,5 @@
 ================================================
-doc2dash: Create docsets for Dash.app and clones
+doc2dash: Create docsets for Dash.app and Clones
 ================================================
 
 Release v\ |release| (:doc:`What's new? <changelog>`).
@@ -9,25 +9,14 @@ Release v\ |release| (:doc:`What's new? <changelog>`).
       :start-after: begin
 
 
-Supported Input Formats
-=======================
-
-Currently, the following input formats are supported:
-
-- Sphinx_’s HTML output (nearly every single Python project out there)
-- pydoctor_’s HTML output (Twisted_!)
-
-Feel free to help adding more! While ``doc2dash`` is implemented in Python, the scope for the supported documentation types is unlimited.
-So go on and submit a parser for your favourite Ruby, Haskell, Lisp, Erlang, JavaScript, …  format!
-
-
 User's Guide
 ============
 
 .. toctree::
    :maxdepth: 1
 
    installation
+   formats
    usage
 
 
@@ -47,7 +36,3 @@ Indices and tables
 
 * :ref:`genindex`
 * :ref:`search`
-
-.. _Twisted: https://twistedmatrix.com/
-.. _pydoctor: https://launchpad.net/pydoctor
-.. _Sphinx:  http://sphinx-doc.org/

docs/installation.rst

@@ -1,15 +1,16 @@
-Installation
-============
+Requirements and Installation
+=============================
 
-The latest stable version can be always found on PyPI_ and can therefore be installed using a simple::
+The latest stable version can be always found on PyPI_.
 
-   $ pip install --user doc2dash
+Since it's a stand-alone tool, I recommend to install it using pipsi_.
 
-If you haven’t pip_ yet, installation should be as easy as::
+Of course, you can also install it as usual using pip_::
 
-   $ curl https://raw.github.com/pypa/pip/master/contrib/get-pip.py | python
+   $ pip install --user doc2dash
 
 ``doc2dash`` runs on Python 2.7, and 3.3+, and PyPy.
+Both Linux and OS X are supported although certain features are only available on OS X.
 
 
 .. _clones:
@@ -30,5 +31,6 @@ Other alternatives have been developed in cooperation with Dash.app's developer
 
 
 .. _pip: https://pip.pypa.io/en/latest/installing.html#install-pip
-.. _PyPI: https://pypi.python.org/pypi/doc2dash/
+.. _PyPI: https://warehouse.python.org/project/doc2dash/
 .. _`Dash.app`: http://kapeli.com/dash/
+.. _pipsi: https://github.com/mitsuhiko/pipsi