docs: swap dead RTD link for GitHub docs URL (closes #58)#75
Draft
bluetoothbot wants to merge 1 commit into
Draft
docs: swap dead RTD link for GitHub docs URL (closes #58)#75bluetoothbot wants to merge 1 commit into
bluetoothbot wants to merge 1 commit into
Conversation
Closes Bluetooth-Devices#58. The Read the Docs site at https://uart-devices.readthedocs.io returns "Project not found" — the project has never been imported on RTD. Until RTD is wired up, swap the badge + Documentation/documentation URLs to GitHub's rendered docs/ directory so the link works. The in-repo .readthedocs.yml and docs/conf.py are left untouched so importing the project on RTD remains a one-click action.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #75 +/- ##
=======================================
Coverage 73.68% 73.68%
=======================================
Files 1 1
Lines 38 38
Branches 3 3
=======================================
Hits 28 28
Misses 10 10 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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.
What
Replace the broken
uart-devices.readthedocs.iolink/badge with a link to the rendereddocs/directory on GitHub.Why
https://uart-devices.readthedocs.io/returns "Project not found" (issue #58) because the project has never been imported on Read the Docs. The in-repo RTD config (.readthedocs.yml,docs/conf.py,pyproject.tomldocs group) is correct — the gap is an admin-side import on app.readthedocs.org.Until RTD is wired up, this PR keeps the documentation link clickable instead of pointing at a 404.
How
readthedocs.svgbuild-status badge and pointed the Documentation line atgithub.com/bluetooth-devices/uart-devices/tree/main/docs.pyproject.toml: same swap for the[tool.poetry] documentation = …URL (this flows into PyPI's "Documentation" project link)..readthedocs.ymlanddocs/conf.pyleft untouched — once the project is imported on RTD, the badge + URLs can be reverted in a one-line follow-up.Testing
git diff --stat: 2 files changed, 2 insertions, 5 deletions.Alternative
If you'd rather import the project on RTD now (https://app.readthedocs.org → Import a Project → bluetooth-devices/uart-devices), this PR can be closed instead — the existing config should build on first try.
Closes #58.
Quality Report
Changes: 2 files changed, 2 insertions(+), 5 deletions(-)
Code scan: clean
Tests: passed (2 passed)
Branch hygiene: clean
Generated by Kōan post-mission quality pipeline