docs: link generated API documentation#245
Open
fengyangxxx wants to merge 1 commit into
Open
Conversation
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.
This change replaces the legacy
godoc.orgdocumentation link with aproject-named Read the Docs site generated from Redsync source by Sourcey:
https://redsync-sourcey-docs.readthedocs.io/en/latest/
The initial site is pinned to Redsync commit
79f6ba24a8bf41f35141de700d410a06bb27622f. It covers the root locking API,Redis interfaces, and the go-redis, Redigo, Rueidis, and Valkey adapter
packages, with search and links back to the corresponding source lines.
The reproducible build source and generated static output are maintained at:
https://github.com/fengyangxxx/redsync-sourcey-docs
The documentation project is transferable. I can invite Redsync maintainers
to both the Read the Docs project and the backing repository so the project
can own future rebuilds or move the static output to a project-controlled
host.
Verification performed before opening this PR:
79f6ba24a8bf41f35141de700d410a06bb27622f3.6.3redis/...tests passedgo test ./...requires the externalredis-serverbinary, which isnot installed in the documentation build environment
No library code or runtime dependency changes are included.