Skip to content

Conversation

bernhardkaindl
Copy link
Contributor

@bernhardkaindl bernhardkaindl commented Sep 3, 2025

Pull Request Overview, generated by Copilot PR review

This PR adds documentation building to the development workflow and introduces comprehensive documentation for the xcp.net module. The purpose is to enable documentation validation as part of the build process and provide proper API documentation for networking-related classes.

  • Adds documentation building with error checking to the CI pipeline via tox
  • Introduces complete API documentation for xcp.net modules using Sphinx
  • Updates existing documentation comments to improve formatting and consistency

PS:

  • Due to an upstream change in how coverage is calculated, the coverage threshold needed to be reduced.
  • This is only a minor reduction by 0.1%, and not caused by any change to the repository itself.
  • For GitHub Copilot review: No change to the project itself. No need to comment on this. Minor.

Summary per file

File Description
xcp/net/ifrename/static.py Improves formatting of documentation comments with proper list markup and corrects capitalisation
xcp/net/ifrename/logic.py Converts docstrings to modern Sphinx format with structured parameter and return documentation
tox.ini Adds docs environment to build documentation with error checking
docs/source/net/*.rst Creates new RST files for documenting xcp.net modules
docs/source/index.rst Reorganises documentation structure to include xcp.net module sections
docs/source/conf.py Removes unused static path configuration
docs/Makefile Removes @ prefix to show sphinx build output
.pre-commit-config.yaml Updates pre-commit hook to include documentation building

This comment was marked as off-topic.

@bernhardkaindl bernhardkaindl force-pushed the docs-add-xcp.net-classes-to-Sphinx-docs branch 2 times, most recently from b44b7bd to 4771ee2 Compare September 3, 2025 04:30
Copilot

This comment was marked as outdated.

@bernhardkaindl bernhardkaindl force-pushed the docs-add-xcp.net-classes-to-Sphinx-docs branch from 51da544 to b501e4e Compare September 23, 2025 11:16
Copilot

This comment was marked as outdated.

@bernhardkaindl bernhardkaindl force-pushed the docs-add-xcp.net-classes-to-Sphinx-docs branch from b501e4e to f5ba695 Compare September 23, 2025 11:19
Copilot

This comment was marked as resolved.

@bernhardkaindl bernhardkaindl force-pushed the docs-add-xcp.net-classes-to-Sphinx-docs branch from d0c5631 to eb2cc53 Compare September 26, 2025 07:45
@bernhardkaindl
Copy link
Contributor Author

Here is a Preview of the updated docs site from this commit:

Class hierarchies of xcp.accessor and xcp.repository:
If you use dark mode, switch the site to bright mode for an improved view of the class diagrams
by clicking on the half-🌔 icon to switch the docs site do "sun" (day) mode (temporarily):

xcp.net.* added, Example:

Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

Copilot reviewed 18 out of 18 changed files in this pull request and generated 2 comments.


Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

Signed-off-by: Bernhard Kaindl <bernhard.kaindl@cloud.com>
Signed-off-by: Bernhard Kaindl <bernhard.kaindl@cloud.com>
Signed-off-by: Bernhard Kaindl <bernhard.kaindl@cloud.com>
Signed-off-by: Bernhard Kaindl <bernhard.kaindl@cloud.com>
@bernhardkaindl bernhardkaindl force-pushed the docs-add-xcp.net-classes-to-Sphinx-docs branch from eb2cc53 to 63c1cf0 Compare September 26, 2025 15:29
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

Copilot reviewed 18 out of 18 changed files in this pull request and generated 2 comments.


Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@bernhardkaindl bernhardkaindl merged commit cea2393 into xenserver:master Sep 26, 2025
9 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.

1 participant