Skip to content

Conversation

bernhardkaindl
Copy link
Contributor

@bernhardkaindl bernhardkaindl commented Aug 26, 2025

Generate Sphinx Documentation and document how to build it.

The docs/static can be opened directly in a web browser, any static site and also readthedocs.io (config included).

Sample Preview URLs:

For further spelling fixes, please review #171 (for CONTRIBUTING.md), and the other non-draft PRs.

Merging the cleanup PRs is a precondition for making spelling fixes (those would cause conflicts otherwise).

Copy link

codecov bot commented Aug 26, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@          Coverage Diff           @@
##           master    #170   +/-   ##
======================================
  Coverage    83.3%   83.3%           
======================================
  Files          23      23           
  Lines        3347    3347           
======================================
  Hits         2790    2790           
  Misses        557     557           
Files with missing lines Coverage Δ
xcp/accessor.py 89.0% <ø> (ø)
xcp/cpiofile.py 75.2% <ø> (ø)

@coveralls
Copy link

coveralls commented Aug 26, 2025

Pull Request Test Coverage Report for Build 17274001479

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 83.358%

Totals Coverage Status
Change from base Build 17124120104: 0.0%
Covered Lines: 2790
Relevant Lines: 3347

💛 - Coveralls

@bernhardkaindl bernhardkaindl force-pushed the deply-docs-using-gh-action-to-pages branch 2 times, most recently from b867404 to b2d41c9 Compare August 26, 2025 21:41
@bernhardkaindl bernhardkaindl force-pushed the deply-docs-using-gh-action-to-pages branch 2 times, most recently from 8143779 to 999d1aa Compare August 27, 2025 16:46
@bernhardkaindl bernhardkaindl changed the title Deply docs using gh action to pages Generate Sphinx Documentation and document how to build it. Aug 27, 2025
Copilot

This comment was marked as outdated.

Copilot

This comment was marked as outdated.

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 deply-docs-using-gh-action-to-pages branch from 7df3ffa to 2eae0b7 Compare August 27, 2025 17:26
@bernhardkaindl bernhardkaindl requested a review from Copilot August 27, 2025 17:26
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

This PR adds comprehensive Sphinx documentation generation to the python-libs project, enabling automatic API documentation and documentation hosting on platforms like ReadTheDocs. The documentation uses Google-style docstrings and includes both project documentation and auto-generated module references.

  • Configures Sphinx with autodoc, MyST parser, and Furo theme for modern documentation
  • Updates existing docstrings to use consistent backtick formatting instead of single quotes
  • Creates individual RST files for each XCP module with auto-documentation directives

Reviewed Changes

Copilot reviewed 30 out of 30 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
docs/source/conf.py Main Sphinx configuration with autodoc and MyST parser setup
docs/source/index.rst Documentation homepage with project structure and module listing
docs/source/*.rst Individual module documentation files for auto-generated API docs
docs/requirements.txt Sphinx dependencies including furo theme and myst_parser
docs/Makefile Standard Sphinx makefile for building documentation
.readthedocs.yml ReadTheDocs configuration for automated documentation hosting
xcp/cpiofile.py Updated docstrings to use backticks instead of single quotes
xcp/accessor.py Improved docstring formatting with proper code block syntax
README.md Fixed markdown syntax and code block language tags
DOCUMENTING.md New documentation guide explaining Google-style docstrings and Sphinx usage

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

@bernhardkaindl bernhardkaindl merged commit 792b5eb into xenserver:master Aug 28, 2025
10 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.

3 participants