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.

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

Add: Add API docs for the pontos.cpe module #917

Merged
merged 1 commit into from
Nov 3, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions docs/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
:maxdepth: 1

pontos/changelog
pontos/cpe
pontos/errors
pontos/git
pontos/github
Expand Down
4 changes: 0 additions & 4 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
6 changes: 2 additions & 4 deletions docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## Requirements

Python 3.7 and later is supported.
Python 3.9 and later is supported.

## Using pip

Expand All @@ -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/).
6 changes: 6 additions & 0 deletions docs/pontos/cpe.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# pontos.cpe package

```{eval-rst}
.. automodule:: pontos.cpe
:members:
```