###################################################
Installation
###################################################

Installation steps
====================================================================

Install Python virtual environment 
on Ubuntu execute : 

.. code-block:: bash
    
    $ apt-get install python3-venv

if Python is not installed it will prompt you to install it.

Create a virtual environment under your working directory.

.. code-block:: bash

    usr1:server:~$ cd ~
    usr1:server:~$ mkdir sphinx
    usr1:server:~$ cd sphinx
    usr1@server:~/sphinx$ python -m venv .venv

In some cases, you should use python3 for python instructions.

.. code-block:: bash

    usr1@server:~/sphinx$ python3 -m venv .venv

Now that the virtual environment is created, you need to activate it to start working.

.. code-block:: bash

    usr1@server:~/sphinx$ source .venv/bin/activate

This command will launch the virtual environment and your prompt will look like this.

.. code-block:: bash

    (.venv) usr1@server:~/sphinx$

The necessary packages and dependencies can now be installed in your virtual environement.

First install sphinx.

.. code-block:: bash

    (.venv) usr1@server:~/sphinx$ pip install sphinx

Check the version of sphinx.

.. code-block:: bash

    (.venv) usr1@server:~/sphinx$ sphinx-build --version

You are now ready to create your first project!