Skip to content

Commit

Permalink
Fix and improve docs for new protocol implementation
Browse files Browse the repository at this point in the history
  • Loading branch information
bjoernricks committed May 31, 2024
1 parent a4fc9fb commit cc64777
Show file tree
Hide file tree
Showing 21 changed files with 307 additions and 518 deletions.
3 changes: 0 additions & 3 deletions docs/api/connections.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,12 @@ Connections

.. autoclass:: SSHConnection
:members:
:inherited-members:

.. autoclass:: TLSConnection
:members:
:inherited-members:

.. autoclass:: UnixSocketConnection
:members:
:inherited-members:

.. autoclass:: DebugConnection
:members:
86 changes: 86 additions & 0 deletions docs/api/enums.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
Enums
-----

python-gvm provides a number of enums that are used to specify values in the
GMP protocol. The following enums are available:

.. autoclass:: gvm.protocols.gmp.requests.AlertCondition
:members:
:undoc-members:

.. autoclass:: gvm.protocols.gmp.requests.AlertEvent
:members:
:undoc-members:

.. autoclass:: gvm.protocols.gmp.requests.AlertMethod
:members:
:undoc-members:

.. autoclass:: gvm.protocols.gmp.requests.AliveTest
:members:
:undoc-members:

.. autoclass:: gvm.protocols.gmp.requests.CredentialFormat
:members:
:undoc-members:

.. autoclass:: gvm.protocols.gmp.requests.CredentialType
:members:
:undoc-members:

.. autoclass:: gvm.protocols.gmp.requests.EntityType
:members:
:undoc-members:

.. autoclass:: gvm.protocols.gmp.requests.FeedType
:members:
:undoc-members:

.. autoclass:: gvm.protocols.gmp.requests.FilterType
:members:
:undoc-members:

.. autoclass:: gvm.protocols.gmp.requests.HostsOrdering
:members:
:undoc-members:

.. autoclass:: gvm.protocols.gmp.requests.HelpFormat
:members:
:undoc-members:

.. autoclass:: gvm.protocols.gmp.requests.InfoType
:members:
:undoc-members:

.. autoclass:: gvm.protocols.gmp.requests.PermissionSubjectType
:members:
:undoc-members:

.. autoclass:: gvm.protocols.gmp.requests.PortRangeType
:members:
:undoc-members:

.. autoclass:: gvm.protocols.gmp.requests.ReportFormatType
:members:
:undoc-members:

.. autoclass:: gvm.protocols.gmp.requests.ResourceType
:members:
:undoc-members:

.. autoclass:: gvm.protocols.gmp.requests.ScannerType
:members:
:undoc-members:

.. autoclass:: gvm.protocols.gmp.requests.SnmpAuthAlgorithm
:members:
:undoc-members:

.. autoclass:: gvm.protocols.gmp.requests.SnmpPrivacyAlgorithm
:members:
:undoc-members:

.. autoclass:: gvm.protocols.gmp.requests.TicketStatus
:members:
:undoc-members:

15 changes: 8 additions & 7 deletions docs/api/gmp.rst
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
.. _gmp:

.. avoid TOCtree warning by marking this file as orphan
:orphan:

GMP
^^^
.. automodule:: gvm.protocols.gmp

Protocol
--------

.. autoclass:: Gmp
.. autoclass:: GMP
:members:

.. toctree::
:maxdepth: 1

gmpv224
gmpv225
enums
116 changes: 0 additions & 116 deletions docs/api/gmpv208.rst

This file was deleted.

116 changes: 0 additions & 116 deletions docs/api/gmpv214.rst

This file was deleted.

Loading

0 comments on commit cc64777

Please sign in to comment.