Skip to content
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
21 changes: 10 additions & 11 deletions docs/api/api.rst → docs/api/api.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
.. _api:
(api)=

Developer Interface
===================
# Developer Interface

This part of the documentation covers all public interfaces of python-gvm.

Expand All @@ -10,11 +9,11 @@ classes for establishing a communication to a remote server, protocol modules
to talk the communication languages, possible raised errors, additional
utilities and xml helpers.

.. toctree::

main
connections
transforms
protocols
errors
other
```{toctree}
main
connections
transforms
protocols
errors
other
```
17 changes: 14 additions & 3 deletions docs/api/connections.rst → docs/api/connections.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,32 @@
.. _connections:
(connections)=

Connections
-----------
# Connections

```{eval-rst}
.. automodule:: gvm.connections
```

```{eval-rst}
.. autoclass:: GvmConnection
:members:
```

```{eval-rst}
.. autoclass:: SSHConnection
:members:
```

```{eval-rst}
.. autoclass:: TLSConnection
:members:
```

```{eval-rst}
.. autoclass:: UnixSocketConnection
:members:
```

```{eval-rst}
.. autoclass:: DebugConnection
:members:
```
7 changes: 4 additions & 3 deletions docs/api/errors.rst → docs/api/errors.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
.. _errors:
(errors)=

Errors
======
# Errors

```{eval-rst}
.. automodule:: gvm.errors
:members:
```
19 changes: 19 additions & 0 deletions docs/api/gmp.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
(gmp)=

# GMP

```{eval-rst}
.. automodule:: gvm.protocols.gmp
```

```{eval-rst}
.. autoclass:: GMP
:members:
```

```{toctree}
:maxdepth: 1

gmpv224
gmpv225
```
15 changes: 0 additions & 15 deletions docs/api/gmp.rst

This file was deleted.

54 changes: 46 additions & 8 deletions docs/api/gmpv224.rst → docs/api/gmpv224.md
Original file line number Diff line number Diff line change
@@ -1,93 +1,131 @@
.. _gmpv224:
(gmpv224)=

GMP v22.4
^^^^^^^^^
# GMP v22.4

```{eval-rst}
.. automodule:: gvm.protocols.gmp._gmp224
```

## Protocol

Protocol
--------

```{eval-rst}
.. autoclass:: gvm.protocols.gmp.GMPv224
:members:
:inherited-members:
```

Enums
-----
## Enums

```{eval-rst}
.. autoclass:: gvm.protocols.gmp.requests.v224.AlertCondition
:members:
:undoc-members:
```

```{eval-rst}
.. autoclass:: gvm.protocols.gmp.requests.v224.AlertEvent
:members:
:undoc-members:
```

```{eval-rst}
.. autoclass:: gvm.protocols.gmp.requests.v224.AlertMethod
:members:
:undoc-members:
```

```{eval-rst}
.. autoclass:: gvm.protocols.gmp.requests.v224.AliveTest
:members:
:undoc-members:
```

```{eval-rst}
.. autoclass:: gvm.protocols.gmp.requests.v224.CredentialFormat
:members:
:undoc-members:
```

```{eval-rst}
.. autoclass:: gvm.protocols.gmp.requests.v224.CredentialType
:members:
:undoc-members:
```

```{eval-rst}
.. autoclass:: gvm.protocols.gmp.requests.v224.EntityType
:members:
:undoc-members:
```

```{eval-rst}
.. autoclass:: gvm.protocols.gmp.requests.v224.FeedType
:members:
:undoc-members:
```

```{eval-rst}
.. autoclass:: gvm.protocols.gmp.requests.v224.FilterType
:members:
:undoc-members:
```

```{eval-rst}
.. autoclass:: gvm.protocols.gmp.requests.v224.HostsOrdering
:members:
:undoc-members:
```

```{eval-rst}
.. autoclass:: gvm.protocols.gmp.requests.v224.HelpFormat
:members:
:undoc-members:
```

```{eval-rst}
.. autoclass:: gvm.protocols.gmp.requests.v224.InfoType
:members:
:undoc-members:
```

```{eval-rst}
.. autoclass:: gvm.protocols.gmp.requests.v224.PermissionSubjectType
:members:
:undoc-members:
```

```{eval-rst}
.. autoclass:: gvm.protocols.gmp.requests.v224.PortRangeType
:members:
:undoc-members:
```

```{eval-rst}
.. autoclass:: gvm.protocols.gmp.requests.v224.ReportFormatType
:members:
:undoc-members:
```

```{eval-rst}
.. autoclass:: gvm.protocols.gmp.requests.v224.ScannerType
:members:
:undoc-members:
```

```{eval-rst}
.. autoclass:: gvm.protocols.gmp.requests.v224.SnmpAuthAlgorithm
:members:
:undoc-members:
```

```{eval-rst}
.. autoclass:: gvm.protocols.gmp.requests.v224.SnmpPrivacyAlgorithm
:members:
:undoc-members:
```

```{eval-rst}
.. autoclass:: gvm.protocols.gmp.requests.v224.TicketStatus
:members:
:undoc-members:
```
Loading