Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve docs for running pip with Python 3 #309

Merged
merged 1 commit into from
Oct 29, 2020
Merged

Improve docs for running pip with Python 3 #309

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 3 additions & 7 deletions docs/install.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,6 @@ Installation of gvm-tools
The current universally applicable installation process for Python is using
the `pip`_ installer tool in conjunction with the `pypi`_ package repository.

.. note:: All commands listed here use the general tool names. If some of these
tools are provided by your distribution, you may need to explicitly use the
Python 3 version of the tool, e.g. :program:`pip3`.

Installing the Latest Stable Release of gvm-tools
-------------------------------------------------

Expand All @@ -23,7 +19,7 @@ The following command installs :program:`gvm-tools` system wide:

.. code-block:: shell

pip install gvm-tools
python3 -m pip install gvm-tools

A system wide installation usually requires admin permissions. Therefore,
:program:`gvm-tools` may only be installed for the
Expand All @@ -32,7 +28,7 @@ via:

.. code-block:: shell

pip install --user gvm-tools
python3 -m pip install --user gvm-tools

For further details and additional installation options, please take a look at
the documentation of `pip`_.
Expand Down Expand Up @@ -83,7 +79,7 @@ Once there is a copy of the source, it can be installed into the current Python

.. code-block:: shell

pip install -e /path/to/gvm-tools
python3 -m pip install -e /path/to/gvm-tools

.. _pip: https://pip.pypa.io/en/stable/
.. _poetry: https://python-poetry.org/
Expand Down