-
Notifications
You must be signed in to change notification settings - Fork 7.6k
feat(docs): Add Zigbee library API documentation #11525
New issue
Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? # to your account
base: master
Are you sure you want to change the base?
Conversation
👋 Hello P-R-O-C-H-Y, we appreciate your contribution to this project! 📘 Please review the project's Contributions Guide for key guidelines on code, documentation, testing, and more. 🖊️ Please also make sure you have read and signed the Contributor License Agreement for this project. Click to see more instructions ...
Review and merge process you can expect ...
|
Thank you very much for your contribution, @P-R-O-C-H-Y. It will take some time, but I'll review ASAP. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think there are some leftover python and temp files
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR introduces comprehensive API documentation for the new Zigbee library and supporting scripts to clean up and standardize existing RST files.
- Added scripts to remove example blocks and fix RST underlines
- Expanded
libraries.rst
with a new Zigbee section in the table of contents - Created detailed API reference files under
docs/en/zigbee/
for core and endpoint classes
Reviewed Changes
Copilot reviewed 31 out of 32 changed files in this pull request and generated 1 comment.
Show a summary per file
File | Description |
---|---|
remove_api_examples.py | Script to strip individual API examples from RST files |
fix_rst_underlines.py | Script to correct RST subtitle underlines |
docs/fix_rst_underlines.py | Duplicate underline-fixing script in docs/ directory |
docs/en/libraries.rst | Added Zigbee APIs section to library index |
docs/en/zigbee/zigbee.rst | Top-level Zigbee overview and toctree |
docs/en/zigbee/zigbee_core.rst | Core class (ZigbeeCore ) API documentation |
docs/en/zigbee/zigbee_ep.rst | Base endpoint (ZigbeeEP ) API documentation |
docs/en/zigbee/ep_*.rst | Individual endpoint API reference files |
Comments suppressed due to low confidence (3)
docs/en/zigbee/zigbee.rst:70
- The text refers to a
Zigbee
class, but elsewhere the core class is namedZigbeeCore
. For consistency, update this reference toZigbeeCore
or clarify the naming.
The Zigbee class is implemented as a singleton, meaning there's only one instance available globally. You access it directly as ``Zigbee`` without creating an instance.
fix_rst_underlines.py:1
- [nitpick] There are two
fix_rst_underlines.py
scripts in separate directories. It would improve maintainability to consolidate them into a single, well-documented script.
#!/usr/bin/env python3
remove_api_examples.py:13
- [nitpick] The regex for matching example blocks may not cover all code-block variations and could miss multi-sentence sections. Consider using a more robust pattern (e.g., matching until a blank line or next heading) to ensure complete removal.
pattern = r'\*\*Example:\*\*\s*\n\s*\n\s*\.\. code-block:: arduino\s*\n\s*\n\s*[^.]*?\.\s*\n\s*\n'
@lucasssvaz Removed, thanks :) |
Description of Change
This pull request adds documentation for new Zigbee library, expanding the API coverage.
libraries.rst
that organizes Zigbee-related APIs under their own subsection, improving navigation and discoverability.Tests scenarios
Related links
Closes #10135