Open
Conversation
bernhardkaindl
force-pushed
the
docs-add-xcp.net-classdoc-to-docs.2
branch
from
7f74f94 to
f6ba8fb
Compare
bernhardkaindl
force-pushed
the
docs-add-xcp.net-classdoc-to-docs.2
branch
from
524cb68 to
6bc4801
Compare
bernhardkaindl
force-pushed
the
docs-add-xcp.net-classdoc-to-docs.2
branch
from
5ba33b6 to
95d9a64
Compare
bernhardkaindl
force-pushed
the
docs-add-xcp.net-classdoc-to-docs.2
branch
from
fc829b6 to
214047b
Compare
bernhardkaindl
force-pushed
the
docs-add-xcp.net-classdoc-to-docs.2
branch
from
95da368 to
ac510b0
Compare
bernhardkaindl
force-pushed
the
docs-add-xcp.net-classdoc-to-docs.2
branch
from
c7ca9f1 to
5311566
Compare
bernhardkaindl
force-pushed
the
docs-add-xcp.net-classdoc-to-docs.2
branch
from
5311566 to
38977a9
Compare
bernhardkaindl
force-pushed
the
docs-add-xcp.net-classdoc-to-docs.2
branch
from
4840e81 to
c8cc870
Compare
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.2
branch
from
c7feded to
b0b5d53
Compare
bernhardkaindl
force-pushed
the
docs-add-xcp.net-classdoc-to-docs.2
branch
from
b0b5d53 to
53a1bb9
Compare
bernhardkaindl
force-pushed
the
docs-add-xcp.net-classdoc-to-docs.2
branch
2 times, most recently
from
c516099 to
c0a2c0f
Compare
bernhardkaindl
force-pushed
the
docs-add-xcp.net-classdoc-to-docs.2
branch
from
c0a2c0f to
bdeaace
Compare
bernhardkaindl
force-pushed
the
docs-add-xcp.net-classdoc-to-docs.2
branch
from
bdeaace to
4b5d14e
Compare
bernhardkaindl
force-pushed
the
docs-add-xcp.net-classdoc-to-docs.2
branch
from
4b5d14e to
931eacf
Compare
bernhardkaindl
force-pushed
the
docs-add-xcp.net-classdoc-to-docs.2
branch
from
931eacf to
4bd901b
Compare
Signed-off-by: Bernhard Kaindl <bernhard.kaindl@cloud.com>
bernhardkaindl
force-pushed
the
docs-add-xcp.net-classdoc-to-docs.2
branch
from
4bd901b to
ced6bf6
Compare
There was a problem hiding this comment.
Pull Request Overview
This PR enhances documentation by converting docstrings to numpy-style format and adding Sphinx documentation generation capabilities.
- Converts function docstrings from custom format to standardized numpy-style documentation
- Adds Sphinx documentation build configuration and tox environment
- Improves formatting and consistency in module-level docstrings
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| xcp/net/ifrename/static.py | Updates module docstring formatting with markdown-style list items and corrected abbreviations |
| xcp/net/ifrename/logic.py | Converts function docstrings to numpy-style format and adds terminology definitions |
| tox.ini | Adds docs environment for Sphinx documentation building |
| docs/source/conf.py | Comments out unused static path configuration |
| docs/Makefile | Removes silent mode from Sphinx build command |
| .pre-commit-config.yaml | Updates tox command to include docs environment |
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.
2: Docs add xcp.net classdoc to docs.2