Skip to content

Restructure docs into logical sections#649

Merged
gijzelaerr merged 4 commits intomasterfrom
cleanup/restructure-docs
Mar 20, 2026
Merged

Restructure docs into logical sections#649
gijzelaerr merged 4 commits intomasterfrom
cleanup/restructure-docs

Conversation

@gijzelaerr
Copy link
Owner

Summary

  • Split monolithic examples.rst and troubleshooting.rst into focused, topic-based pages
  • Grouped docs under clear toctree sections: Getting Started, User Guide, Troubleshooting, Development, API Reference
  • Merged duplicated TIA Portal / PUT/GET config into a single tia-portal-config.rst page
  • No content was removed — all existing documentation is preserved, just reorganized

New page structure

Section Pages
Getting Started introduction, installation, plc-support
User Guide connecting, reading-writing, multi-variable, server, tia-portal-config
Troubleshooting error-reference, connection-issues, thread-safety, limitations
Development development
API Reference client, async_client, s7commplus, server, partner, logo, type, util, connection, s7protocol, datatypes

Test plan

  • Sphinx build succeeds with -W (warnings as errors), zero warnings

🤖 Generated with Claude Code

gijzelaerr and others added 4 commits March 20, 2026 13:07
README:
- Remove async support section (unnecessary on landing page)

Documentation:
- Add S7CommPlus API docs with experimental warning
- Add experimental warning to AsyncClient docs
- Update PLC support matrix for S7CommPlus V1/V2 status

Test consolidation (no test logic changed):
- Merge test_server_coverage.py into test_server.py
- Merge test_partner_coverage.py into test_partner.py
- Merge test_logo_coverage.py into test_logo_client.py
- Merge test_db_coverage.py into test_util.py
- Rename test_s7protocol_coverage.py to test_s7protocol.py

Mypy fixes:
- Widen Row.set_value type to accept date/datetime/timedelta
- Add type annotations in test_s7protocol.py, test_partner.py,
  test_connection.py, test_async_client.py

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Add 154 new unit tests covering codec decoders, PValue parsing for all
data types, payload builders/parsers, connection response parsing, and
client error paths. S7CommPlus coverage rises from 77% to 87%, with
codec.py reaching 100%. Also add CODECOV_TOKEN to the workflow to fix
silent upload failures on protected branches.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Split the monolithic examples.rst and troubleshooting.rst into focused,
topic-based pages and group them under clear sections in the toctree:
Getting Started, User Guide, Troubleshooting, Development, API Reference.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@codecov-commenter
Copy link

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 80.76%. Comparing base (394128b) to head (425b3ef).
⚠️ Report is 194 commits behind head on master.
❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@             Coverage Diff             @@
##           master     #649       +/-   ##
===========================================
+ Coverage   54.60%   80.76%   +26.16%     
===========================================
  Files          13       25       +12     
  Lines        1661     6796     +5135     
===========================================
+ Hits          907     5489     +4582     
- Misses        754     1307      +553     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@gijzelaerr gijzelaerr merged commit 76acf91 into master Mar 20, 2026
37 checks passed
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