Skip to content

docs: tighten the DB driver docs and add pyzm.zm.db to the API reference - #88

Merged
pliablepixels merged 2 commits into
masterfrom
docs/db-followup
Oct 25, 2026
Merged

pliablepixels merged 2 commits into
masterfrom
docs/db-followup

Conversation

@pliablepixels

@pliablepixels pliablepixels commented Oct 25, 2026 •

Copy link
Copy Markdown
Member

Follow-up to #87, from a pass over the docs against the merged code.

Acceptance

  • The upgrade note in installation.rst describes when zmesNg's install.sh switches drivers (once its hooks require this pyzm and its checks pass), and links to the zmesNg note that lists those checks.
  • The MySQL 8 note says logins without cryptography work only while the server has the password cached, so they can fail after a MySQL restart.
  • connect, dict_cursor, driver_available and get_zm_db are in the API reference (docs/source/pyzm.rst).
  • zm_events.rst says how pyzm finds zm.conf (conf_path, PYZM_CONFPATH, then /etc/zm, /config, /etc/zoneminder) instead of only /etc/zm/zm.conf.

Sphinx builds with -W (no warnings). No code change.

🤖 Generated with Claude Code

- The upgrade note no longer says install.sh switches drivers on a single
  PyMySQL connection; it switches once its hooks require this pyzm and its
  checks pass.
- The MySQL 8 note says logins without cryptography work only while the
  server has the password cached.
- connect, dict_cursor, driver_available and get_zm_db are in the API
  reference.

Refs #85

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@pliablepixels pliablepixels added the documentation Improvements or additions to documentation label Oct 25, 2026
Refs #85

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@pliablepixels
pliablepixels merged commit e669650 into master Oct 25, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant