docs: tox envs: Build docs to check for errors#12
Open
bernhardkaindl wants to merge 1 commit intomasterfrom
Open
docs: tox envs: Build docs to check for errors#12bernhardkaindl wants to merge 1 commit intomasterfrom
bernhardkaindl wants to merge 1 commit intomasterfrom
Conversation
There was a problem hiding this comment.
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
docsenvironment to tox configuration that builds documentation with--fail-on-warningflag - 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 Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Signed-off-by: Bernhard Kaindl <bernhard.kaindl@cloud.com>
bernhardkaindl
force-pushed
the
docs-add-xcp.net-classdoc-to-docs
branch
from
2869926 to
64bcb08
Compare
Pull Request Test Coverage Report for Build 17420052766Details
💛 - Coveralls |
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.
docs: tox envs: Build docs to check for errors