.. _installation:

Installing Python
=================

To work with sphinx documentation you need to install Python first. Since I work on Windows, I'll follow that route. When you work on linux or ios you should be good already and you can skip this part.

Go to the `Python homepage <https://www.python.org>`_ and download a compatible version. Spinx itself recommends version 2.7, so that's what I got (2.7.13 to be precise). Follow along with the installation instructions. 

.. image:: _images\2017-03-27_224859.png

*Sphinx has a good installation guide* `here <http://www.sphinx-doc.org/en/stable/install.html#windows-install-python-and-sphinx>`_

Environment variables
---------------------

Once installation has finished, it's advised to add a few environment variables. Go to your control panel in windows and add this to your ``Path`` environment variables: ``C:\Python27;C:\Python27\Scripts``.

.. image:: _images\2017-03-27_224614.png

*Finding the environment variables in windows 10*

.. image:: _images\2017-03-27_225607.png

*Setup your environment values like so*

Installing Sphinx
-----------------

After you've installed Python, you need to install Sphinx. You can do this directly from within Python, given that you've got the pip module. This is the Python packet manager and it should be included in the latest Python versions.

Just type ``pip install sphinx`` in a command prompt and it should install all by itself.

.. image:: _images\2017-03-27_225808.png

*Install Sphinx with pip in the commandline*

Read the Docs theme
-------------------

I like the looks of the `Read the Docs theme <https://github.com/rtfd/sphinx_rtd_theme>`_, so I also install that by entering ``pip install sphinx_rtd_theme`` in a command prompt.

Summary
-------

At this moment you should have installed the following items

- Python
- Sphinx
- Read the docs theme for Sphinx