From 32b44fbf818db14c6b4edbd7af0fe94585f1183d Mon Sep 17 00:00:00 2001 From: kaburagisec <135169292+kaburagisec@users.noreply.github.com> Date: Mon, 19 Oct 2026 12:33:59 +0700 Subject: [PATCH] fix(docs): Update release links to use relative paths in documentation --- onvif/client.py | 18 +++++++++--------- onvif/operator.py | 2 +- onvif/utils/discovery.py | 4 ++-- onvif/utils/error_handlers.py | 6 +++--- onvif/utils/plugins.py | 4 ++-- onvif/utils/wsdl.py | 2 +- 6 files changed, 18 insertions(+), 18 deletions(-) diff --git a/onvif/client.py b/onvif/client.py index 138632c..b624477 100644 --- a/onvif/client.py +++ b/onvif/client.py @@ -128,9 +128,9 @@ class ONVIFClient: plugins (list[Plugin] | None): List of user-provided Zeep plugins (if any) !!! tip "Version History" - - Added in [`v0.0.6`](/onvif-python/releases/#v0.0.6): `xml_plugin` - - Added in [`v0.1.0`](/onvif-python/releases/#v0.1.0): `wsdl_dir` - - Added in [`v0.4.3`](/onvif-python/releases/#v0.4.3): `plugins` + - Added in [`v0.0.6`](/releases/#v0.0.6): `xml_plugin` + - Added in [`v0.1.0`](/releases/#v0.1.0): `wsdl_dir` + - Added in [`v0.4.3`](/releases/#v0.4.3): `plugins` """ def __init__( @@ -167,12 +167,12 @@ def __init__( plugins (list[Plugin] | None): List of user-provided Zeep plugins (`zeep.Plugin`) !!! tip "Version History" - - Added in [`v0.0.4`](/onvif-python/releases/#v0.0.4): `apply_patch` - - Added in [`v0.0.6`](/onvif-python/releases/#v0.0.6): `capture_xml` - - Added in [`v0.1.0`](/onvif-python/releases/#v0.1.0): `wsdl_dir` - - Added in [`v0.2.2`](/onvif-python/releases/#v0.2.2): `plugins` - - Added in [`v0.3.0`](/onvif-python/releases/#v0.3.0): `http_digest` - - Changed in [`v0.3.0`](/onvif-python/releases/#v0.3.0): `username` → `str | None`, + - Added in [`v0.0.4`](/releases/#v0.0.4): `apply_patch` + - Added in [`v0.0.6`](/releases/#v0.0.6): `capture_xml` + - Added in [`v0.1.0`](/releases/#v0.1.0): `wsdl_dir` + - Added in [`v0.2.2`](/releases/#v0.2.2): `plugins` + - Added in [`v0.3.0`](/releases/#v0.3.0): `http_digest` + - Changed in [`v0.3.0`](/releases/#v0.3.0): `username` → `str | None`, `password` → `str | None` """ logger.info("Initializing ONVIF client for %s:%d", host, port) diff --git a/onvif/operator.py b/onvif/operator.py index 6005578..6c9c1b4 100644 --- a/onvif/operator.py +++ b/onvif/operator.py @@ -42,7 +42,7 @@ class CacheMode(Enum): DB (Literal['db']): Persistent SQLite caching across process restarts. !!! tip "Version History" - - Removed in [`v0.4.0`](/onvif-python/releases/#v0.4.0): `CacheMode.ALL` + - Removed in [`v0.4.0`](/releases/#v0.4.0): `CacheMode.ALL` """ NONE = "none" diff --git a/onvif/utils/discovery.py b/onvif/utils/discovery.py index 3ef0761..fdd21a9 100644 --- a/onvif/utils/discovery.py +++ b/onvif/utils/discovery.py @@ -44,7 +44,7 @@ class ONVIFDiscovery: interface (str | None): Network interface IP to bind to (default: auto-detect) !!! tip "Version History" - - Changed in [`v0.4.0`](/onvif-python/releases/#v0.4.0): + - Changed in [`v0.4.0`](/releases/#v0.4.0): ~~`WS_DISCOVERY_ADDRESS_IPv4`~~ → `WS_DISCOVERY_ADDRESS_IPV4` """ @@ -168,7 +168,7 @@ def discover( | `services` | `list[str]` | List of supported ONVIF services; empty if none are available | !!! tip "Version History" - - Added in [`v0.4.0`](/onvif-python/releases/#v0.4.0): `hostname`, `date_time`, and `services` + - Added in [`v0.4.0`](/releases/#v0.4.0): `hostname`, `date_time`, and `services` """ local_ip = self.get_local_ip() logger.info("Starting ONVIF device discovery (timeout: %ss)", self.timeout) diff --git a/onvif/utils/error_handlers.py b/onvif/utils/error_handlers.py index 468212a..dfcee23 100644 --- a/onvif/utils/error_handlers.py +++ b/onvif/utils/error_handlers.py @@ -16,8 +16,8 @@ cases. !!! tip "Version History" - - Available since [`v0.0.7`](/onvif-python/releases/#v0.0.7) as `ONVIFErrorHandler` - - Refactor to module since [`v0.4.0`](/onvif-python/releases/#v0.4.0) + - Available since [`v0.0.7`](/releases/#v0.0.7) as `ONVIFErrorHandler` + - Refactor to module since [`v0.4.0`](/releases/#v0.4.0) !!! abstract "Features" - Detect `ActionNotSupported` SOAP faults @@ -138,7 +138,7 @@ def safe_call( Defaults to `True`. !!! tip "Version History" - - Changed in [`v0.4.0`](/onvif-python/releases/#v0.4.0): + - Changed in [`v0.4.0`](/releases/#v0.4.0): ~~`ignore_unsupported`~~ → `handle_unsupported`. Returns: diff --git a/onvif/utils/plugins.py b/onvif/utils/plugins.py index ffd3330..e2e88cf 100644 --- a/onvif/utils/plugins.py +++ b/onvif/utils/plugins.py @@ -35,7 +35,7 @@ class XMLCapturePlugin(Plugin): history (list[dict[str, Any]]): All captured requests/responses with metadata !!! tip "Version History" - - Moved to `plugins` since [`v0.4.0`](/onvif-python/releases/#v0.4.0) + - Moved to `plugins` since [`v0.4.0`](/releases/#v0.4.0) !!! question "The plugin automatically captures" - Outgoing SOAP requests (`egress`) @@ -337,7 +337,7 @@ class ONVIFParser(Plugin): responses !!! tip "Version History" - - Moved to `plugins` since [`v0.3.1`](/onvif-python/releases/#v0.3.1) + - Moved to `plugins` since [`v0.3.1`](/releases/#v0.3.1) ??? example "Usage" ```python linenums="1" diff --git a/onvif/utils/wsdl.py b/onvif/utils/wsdl.py index 25a4cd5..cfbd9fc 100644 --- a/onvif/utils/wsdl.py +++ b/onvif/utils/wsdl.py @@ -300,7 +300,7 @@ def get_definition( | `namespace` | `str` | XML namespace URI | !!! tip "Version History" - - Added in [`v0.4.5`](/onvif-python/releases/#v0.4.5): `filename` + - Added in [`v0.4.5`](/releases/#v0.4.5): `filename` ??? note - Most services use ver10, some newer ones use ver20