Skip to content

Update release links to use relative paths in documentation #185

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.

Sign up for GitHub

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

Merged
kaburagisec merged 1 commit into from
Oct 19, 2026
Merged

Update release links to use relative paths in documentation #185

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 9 additions & 9 deletions onvif/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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__(
Expand Down Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion onvif/operator.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
4 changes: 2 additions & 2 deletions onvif/utils/discovery.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`
"""

Expand Down Expand Up @@ -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)
Expand Down
6 changes: 3 additions & 3 deletions onvif/utils/error_handlers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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:
Expand Down
4 changes: 2 additions & 2 deletions onvif/utils/plugins.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`)
Expand Down Expand Up @@ -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"
Expand Down
2 changes: 1 addition & 1 deletion onvif/utils/wsdl.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading