Replace dummy module with MkDocs build test#3
Merged
KristopherKubicki merged 2 commits intostagingfrom Jun 22, 2025
Merged
Conversation
There was a problem hiding this comment.
Pull Request Overview
This pull request replaces the dummy module with a proper MkDocs build test, updates documentation, and removes outdated tests. Key changes include:
- Removing dummy.py and its tests.
- Adding a new test to verify that the MkDocs site builds successfully.
- Updating MkDocs configuration and documentation in README files.
Reviewed Changes
Copilot reviewed 6 out of 7 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| tests/test_mkdocs.py | Added a test to run "mkdocs build" using subprocess. |
| tests/test_dummy.py | Removed tests for the dummy module. |
| profile/README.md | Updated to reference main README for repository configuration. |
| mkdocs.yml | Added configuration for MkDocs documentation build. |
| dummy.py | Removed dummy module implementation. |
| README.md | Added documentation and instructions for MkDocs. |
Comments suppressed due to low confidence (1)
tests/test_mkdocs.py:8
- The test may fail with a FileNotFoundError if 'mkdocs' is not installed. Consider adding a check for the existence of the mkdocs command or marking the test to be skipped when mkdocs is absent.
result = subprocess.run([
Codecov ReportAll modified and coverable lines are covered by tests ✅ 📢 Thoughts on this report? Let us know! |
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.
Summary
dummy.pyand its testsTesting
python -m pytest -q(fails: FileNotFoundError: 'mkdocs')https://chatgpt.com/codex/tasks/task_e_68581900cf608333835a835e396fccf6