-
Notifications
You must be signed in to change notification settings - Fork 1
Docs add xcp.net classes to sphinx docs #15
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.
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
base: master
Are you sure you want to change the base?
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Pull Request Test Coverage Report for Build 17964295374Details
💛 - Coveralls |
caac83a to
b44b7bd
Compare
b44b7bd to
4771ee2
Compare
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 enhances documentation by adding sphinx documentation generation support and improving code documentation standards. The changes focus on making the project documentation more robust and comprehensive.
- Added sphinx documentation build configuration and integration with tox
- Updated docstrings to follow proper sphinx/numpy-style documentation format
- Corrected capitalization and formatting inconsistencies in comments and documentation
Reviewed Changes
Copilot reviewed 15 out of 15 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| xcp/net/ifrename/static.py | Fixed capitalization inconsistencies in comments (MAC, PCI, SMBIOS) |
| xcp/net/ifrename/logic.py | Enhanced function docstrings with proper numpy-style documentation format |
| tox.ini | Added docs environment for sphinx documentation building |
| docs/source/conf.py | Commented out unused static path configuration |
| docs/Makefile | Removed @ prefix to show sphinx build output |
| .pre-commit-config.yaml | Updated tox environment to include docs testing |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| Parameters | ||
| ---------- | ||
| static_rules : list[MACPCI] |
Copilot
AI
Sep 3, 2025
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.
The type annotation list[MACPCI] uses a generic list type that may not be available in older Python versions. Consider using List[MACPCI] from typing module or typing.List[MACPCI] for better compatibility, especially since this appears to be documentation that should be accurate across Python versions.
| static_rules : list[MACPCI] | ||
| List of MACPCI objects representing rules | ||
| @param cur_state | ||
| cur_state : list[MACPCI] | ||
| List of MACPCI objects representing the current state | ||
| @param last_state | ||
| last_state : list[MACPCI] | ||
| List of MACPCI objects representing the last boot state | ||
| @param old_state | ||
| old_state : list[MACPCI] |
Copilot
AI
Sep 3, 2025
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.
The type annotation list[MACPCI] uses a generic list type that may not be available in older Python versions. Consider using List[MACPCI] from typing module or typing.List[MACPCI] for better compatibility, especially since this appears to be documentation that should be accurate across Python versions.
d0c5631 to
eb2cc53
Compare
Signed-off-by: Bernhard Kaindl <[email protected]>
Signed-off-by: Bernhard Kaindl <[email protected]>
Signed-off-by: Bernhard Kaindl <[email protected]>
Signed-off-by: Bernhard Kaindl <[email protected]>
Signed-off-by: Bernhard Kaindl <[email protected]>
Signed-off-by: Bernhard Kaindl <[email protected]>
Signed-off-by: Bernhard Kaindl <[email protected]>
Signed-off-by: Bernhard Kaindl <[email protected]>
Signed-off-by: Bernhard Kaindl <[email protected]>
eb2cc53 to
63c1cf0
Compare
2-new:
Docs add xcp.net classes to sphinx docs