diff --git a/docs/index.rst b/docs/index.rst index 5bd37ef1f..364e3de42 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -6,14 +6,19 @@ Vulnerability Manager (GVM). .. note:: **python-gvm** requires at least Python 3.5. Python 2 is not supported. +User Guide +---------- + +This sections explains how to install python-gvm and shows example use cases. + .. toctree:: :maxdepth: 2 install - userguide + usage -The API Documentation / Guide ------------------------------ +The API Documentation +--------------------- If you are looking for information on a specific function, class, or method, this part of the documentation is for you. diff --git a/docs/install.rst b/docs/install.rst index f3c946797..b2162a920 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -1,4 +1,42 @@ .. _install: -Installation -============ +Installation of python-gvm +========================== + +Using pip +--------- + +You can install the latest stable release of python-gvm from the Python Package +Index using `pip`_:: + + pip install gvm + + +Using pipenv +------------ + +If you are developing an application or library that uses **python-gvm** +internally it is often better to choose `pipenv`_ for handling your +dependencies.:: + + pipenv install gvm + +If you aren't using `pipenv`_ yet head over to the pipenv website for +installation instructions. + +Getting the Source +------------------ + +The source code of python-gvm can be found at +`Github `_. + +To clone the public repository run:: + + git clone git://github.com/greenbone/python-gvm + +Once you have a copy of the source, you can embed it in your own application:: + + pip install -e /path/to/python-gvm + +.. _pip: https://pip.pypa.io/ +.. _pipenv: http://pipenv.org/ diff --git a/docs/userguide.rst b/docs/usage.rst similarity index 89% rename from docs/userguide.rst rename to docs/usage.rst index 0ff67071b..e254ff2a6 100644 --- a/docs/userguide.rst +++ b/docs/usage.rst @@ -1,7 +1,7 @@ -.. _userguide: +.. _usage: -Userguide -========= +Usage +===== Introduction ------------