-
Notifications
You must be signed in to change notification settings - Fork 1
Docs add xcp.net classdoc to docs.3 #14
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
Signed-off-by: Bernhard Kaindl <[email protected]>
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
c52667d to
53eca83
Compare
Pull Request Test Coverage Report for Build 17422497550Details
💛 - Coveralls |
Signed-off-by: Bernhard Kaindl <[email protected]>
Signed-off-by: Bernhard Kaindl <[email protected]>
53eca83 to
b0efa38
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 adds comprehensive documentation for the xcp.net package by introducing Sphinx documentation generation and improving existing code documentation. The changes include setting up a documentation build system and standardizing docstring formatting to follow modern Python documentation conventions.
Key changes:
- Converts legacy @param/@returns docstrings to NumPy-style documentation format
- Adds Sphinx-based documentation infrastructure with automatic API documentation generation
- Standardizes terminology and formatting across network interface naming documentation
Reviewed Changes
Copilot reviewed 15 out of 15 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| xcp/net/ifrename/static.py | Updates docstring formatting and standardizes terminology (MAC, PCI, SMBIOS) |
| xcp/net/ifrename/logic.py | Converts function docstrings from @param style to NumPy format and adds terminology definitions |
| tox.ini | Adds docs environment for Sphinx documentation building |
| docs/source/*.rst | Creates RST files for automatic API documentation generation |
| docs/source/conf.py | Disables unused static path configuration |
| docs/Makefile | Removes '@' prefix to show Sphinx build commands |
| .pre-commit-config.yaml | Updates tox environment to include docs validation |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Docs add xcp.net classdoc to docs.3