docs: Move to RTD - Update links and remove workflow #131
Conversation
This file contains 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
Change all links to documentation from GitHub pages to Read the Docs. Also clean up the README a bit: - Remove list of links to documentation. This is tedious to maintain and really, people should just go to the documentation. - Move the instructions on how to build the docs from README to the developer instructions in the docs.
Documentation is now hosted on Read the Docs. The build there is triggered through a webhook, so no need for a workflow anymore. Note that the docs_pr.yml workflow is still kept as that is not publishing but for verifying that the documentation can still be built after modifications.
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.
Documentation is now hosted on RTD, which allows for much easier handling of different versions (e.g. current master vs last stable release). This PR does two changes related to that:
Closes #129