Repository navigation
Conversation
The README linked to solisconnect.readthedocs.io, which 404s - the project was rebranded from solis_modbus and an RTD project under the new name was never created. Rather than depend on an external RTD dashboard import, build the existing Sphinx docs and deploy them to GitHub Pages via a workflow, and repoint the README (main link plus the Waveshare sensors deep-link) at https://fboundy.github.io/solisconnect/. The .readthedocs.yaml is left in place so RTD still works if the project is later imported. Fixes #33
Contributor
|
Failed to generate code suggestions for PR |
2 tasks done
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
1 participant
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
Fixes #33 — the README's "Documentation" link (
solisconnect.readthedocs.io) returns 404. The project was rebranded fromsolis_modbus, and an RTD project under the new name was never created (readthedocs.org/api/v3/projects/solisconnect/→ "No Project matches the given query").Rather than depend on an external RTD dashboard import (which I can't do from the repo), this builds the existing Sphinx docs (
docs/source, already configured) and deploys them to GitHub Pages:.github/workflows/docs.yaml: build with Sphinx →upload-pages-artifact→deploy-pages, on pushes tomaintouchingdocs/**/README.md/the workflow, plus manual dispatch.html_url: https://fboundy.github.io/solisconnect/).sensors.html#wavesharedeep-link (verified the#waveshareanchor exists in the built output)..readthedocs.yamlleft in place, so RTD still works if the project is later imported.Verification
docs/source, duplicate autosection labels, sensors.md in two toctrees) are pre-existing content-hygiene items, non-fatal in a normal build (matching RTD's default lenient build) — out of scope for this link fix.main; the site will publish at https://fboundy.github.io/solisconnect/.Fixes #33