Open
Conversation
Signed-off-by: Bernhard Kaindl <bernhard.kaindl@cloud.com>
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
bernhardkaindl
force-pushed
the
docs-add-xcp.net-classdoc-to-docs.3
branch
from
c52667d to
53eca83
Compare
Pull Request Test Coverage Report for Build 17422497550Details
💛 - Coveralls |
Signed-off-by: Bernhard Kaindl <bernhard.kaindl@cloud.com>
Signed-off-by: Bernhard Kaindl <bernhard.kaindl@cloud.com>
bernhardkaindl
force-pushed
the
docs-add-xcp.net-classdoc-to-docs.3
branch
from
53eca83 to
b0efa38
Compare
There was a problem hiding this comment.
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Docs add xcp.net classdoc to docs.3