Add versioned book on readthedocs.org #6
Merged
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
This PR adds the file `.readthedocs.yaml`, which is used by readthedocs.org to generate the book on their servers. RTD can be used easily host docs for every rinja version, so users can explore how to use the current stable version, the current HEAD, and an older version. For older versions than the current PR, the books won't be built, because we did not provided the needed `.readthedocs.yaml`. Also an `index.hbs` template skeleton is dynamically generated to made mdbook and RTD work better together. (Only the left sidebar was changed, but you have to override the whole file to make any changes.)
GuillaumeGomez
approved these changes
Jun 18, 2024
|
Awesome, thanks! |
|
Would it be possible to make it updated through github actions whenever a PR is merged? If so, what do you need to make it possible? Oh and final point: should we reset all versions to |
Kijewski
added a commit
to Kijewski/rinja
that referenced
this pull request
Jun 18, 2024
In rinja-rs#6 I forgot to add the most importand file of the PR: .readthedocs.yaml
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 PR adds the file
.readthedocs.yaml, which is used by readthedocs.org to generate the book on their servers. RTD can be used easily host docs for every rinja version, so users can explore how to use the current stable version, the current HEAD, and an older version.For older versions than the current PR, the books won't be built, because we did not provided the needed
.readthedocs.yaml.Also an
index.hbstemplate skeleton is dynamically generated to made mdbook and RTD work better together. (Only the left sidebar was changed, but you have to override the whole file to make any changes.)