Add: Add API docs for the pontos.cpe module

Also update the docs for supported Python versions and drop mentioning pipenv.
greenbone · Nov 3, 2023 · 124bd52 · 124bd52
1 parent 12fd92a
commit 124bd52
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 8 deletions.
diff --git 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
@@ -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
@@ -4,7 +4,7 @@
 
 ## Requirements
 
-Python 3.7 and later is supported.
+Python 3.9 and later is supported.
 
 ## Using pip
 
@@ -21,13 +21,11 @@ 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/)
 
 ```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
@@ -0,0 +1,6 @@
+# pontos.cpe package
+
+```{eval-rst}
+.. automodule:: pontos.cpe
+   :members:
+```