Skip to content

docs: add server_datamodel example to examples page - #3015

Merged
janiversen merged 1 commit into
pymodbus-dev:devfrom
SergioCc13:docs/add-server-datamodel-example
Aug 30, 2026
Merged

docs: add server_datamodel example to examples page#3015
janiversen merged 1 commit into
pymodbus-dev:devfrom
SergioCc13:docs/add-server-datamodel-example

Conversation

@SergioCc13

Copy link
Copy Markdown
Contributor

Description

examples/server_datamodel.py is present in the repo and is exercised by CI (test/examples/test_examples.py::test_server_datamodel), but it was not referenced in doc/source/examples.rst, so it never appeared in the published documentation next to the other server_* examples.

This adds it to the Advanced examples section, right after Server updating, using the same automodule format as the neighbouring entries.

Verification

  • sphinx -b html doc build/html builds cleanly, no new warnings.
  • New "Server datamodel" section renders with the module docstring content.

Discussed first in #3013.

examples/server_datamodel.py exists and is exercised by CI
(test/examples/test_examples.py::test_server_datamodel) but was not
referenced in doc/source/examples.rst, so it never appeared in the
published documentation. Add it to the advanced examples section,
alongside the other server_* examples, using the same automodule
format.

@janiversen janiversen left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, Thanks

@janiversen
janiversen merged commit 7843881 into pymodbus-dev:dev Aug 30, 2026
16 checks passed
@SergioCc13
SergioCc13 deleted the docs/add-server-datamodel-example branch August 30, 2026 10:44
@SergioCc13

Copy link
Copy Markdown
Contributor Author

Thanks for the quick review!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants