-
Notifications
You must be signed in to change notification settings - Fork 1
2: Docs add xcp.net classdoc to docs.2 #13
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
7f74f94 to
f6ba8fb
Compare
524cb68 to
6bc4801
Compare
5ba33b6 to
95d9a64
Compare
fc829b6 to
214047b
Compare
95da368 to
ac510b0
Compare
c7ca9f1 to
5311566
Compare
5311566 to
38977a9
Compare
4840e81 to
c8cc870
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
c7feded to
b0b5d53
Compare
b0b5d53 to
53a1bb9
Compare
c516099 to
c0a2c0f
Compare
c0a2c0f to
bdeaace
Compare
bdeaace to
4b5d14e
Compare
4b5d14e to
931eacf
Compare
931eacf to
4bd901b
Compare
Signed-off-by: Bernhard Kaindl <[email protected]>
4bd901b to
ced6bf6
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 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.
2: Docs add xcp.net classdoc to docs.2