Skip to content

Conversation

@bernhardkaindl
Copy link

docs: tox envs: Build docs to check for errors

Copy link

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 documentation building to the tox configuration to enable error checking during the documentation build process. The primary goal is to catch documentation build errors early in the development workflow.

  • Adds a new docs environment to tox configuration that builds documentation with --fail-on-warning flag
  • Updates tox environment lists to include the new docs environment
  • Removes unused static path configuration in Sphinx config to prevent warnings

Reviewed Changes

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

File Description
tox.ini Adds new docs environment configuration and integrates it into existing test environments
docs/source/conf.py Comments out unused html_static_path configuration to prevent Sphinx warnings
docs/Makefile Removes @ prefix from Sphinx build command to show output
.pre-commit-config.yaml Updates pre-commit hook to include docs environment in tox execution

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

@codecov
Copy link

codecov bot commented Sep 3, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@bernhardkaindl bernhardkaindl force-pushed the docs-add-xcp.net-classdoc-to-docs branch from 2869926 to 64bcb08 Compare September 3, 2025 01:09
@coveralls
Copy link

Pull Request Test Coverage Report for Build 17420052766

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 17419981700: 0.0%
Covered Lines: 2790
Relevant Lines: 3347

💛 - Coveralls

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