Put documentation on readthedocs - #21
Open
Plasdom wants to merge 10 commits into
Open
Conversation
Owner
Author
|
@avadean This was quite straightforward in the end, but if you're able to glance over it and check that this is the best way to do it that would be great. |
avadean
approved these changes
May 28, 2026
avadean
left a comment
avadean
left a comment
Collaborator
There was a problem hiding this comment.
Looks great! I would just add the ReadTheDocs link to the About section of the repository :)
|
|
||
| ## Documentation | ||
|
|
||
| https://sike.readthedocs.io/en/latest/ |
Collaborator
There was a problem hiding this comment.
You can put this link in the "About" section on the repository. In the top right corner (below Watch/Fork/Star) there should be a little cog wheel where you can add it.
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
2 participants
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.
Set up a ReadTheDocs for sphinx documentation