From 16ca9419e7d558bb5d95fde2340e8c6daaa4749d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B6rn=20Ricks?= Date: Fri, 3 Nov 2023 10:55:16 +0100 Subject: [PATCH] Add: Add API docs for the pontos.cpe module Also update the docs for supported Python versions and drop mentioning pipenv. --- docs/api.md | 1 + docs/index.md | 4 ---- docs/install.md | 6 ++---- docs/pontos/cpe.md | 6 ++++++ 4 files changed, 9 insertions(+), 8 deletions(-) create mode 100644 docs/pontos/cpe.md diff --git a/docs/api.md b/docs/api.md index 98684b322..c134d8d9a 100644 --- a/docs/api.md +++ b/docs/api.md @@ -4,6 +4,7 @@ :maxdepth: 1 pontos/changelog +pontos/cpe pontos/errors pontos/git pontos/github diff --git a/docs/index.md b/docs/index.md index a099030ba..10f0099e6 100644 --- a/docs/index.md +++ b/docs/index.md @@ -3,10 +3,6 @@ The pontos Python package is a collection of utilities, tools, classes and functions maintained by Greenbone Networks. -:::{note} -**Pontos** requires at least Python 3.7. Python 2 is not supported. -::: - ## User Guide This sections explains how to install **Pontos** and shows example use cases. diff --git a/docs/install.md b/docs/install.md index e90ffd5fb..49894c439 100644 --- a/docs/install.md +++ b/docs/install.md @@ -4,7 +4,7 @@ ## Requirements -Python 3.7 and later is supported. +Python 3.9 and later is supported. ## Using pip @@ -21,7 +21,7 @@ python3 -m pip install --user pontos Because **pontos** is a Python library you most likely need a tool to handle Python package dependencies and Python environments. Therefore we -strongly recommend using [pipenv](https://pipenv.pypa.io/en/latest/) or [poetry](https://python-poetry.org/). +strongly recommend using [poetry](https://python-poetry.org/). You can install the latest stable release of **pontos** and add it as a dependency for your current project using [poetry](https://python-poetry.org/) @@ -29,5 +29,3 @@ a dependency for your current project using [poetry](https://python-poetry.org/) ```shell poetry add pontos ``` - -For installation via pipenv please take a look at their [documentation](https://pipenv.pypa.io/en/latest/). diff --git a/docs/pontos/cpe.md b/docs/pontos/cpe.md new file mode 100644 index 000000000..15534ec84 --- /dev/null +++ b/docs/pontos/cpe.md @@ -0,0 +1,6 @@ +# pontos.cpe package + +```{eval-rst} +.. automodule:: pontos.cpe + :members: +```