search

rinja-rs / rinja

A template rendering engine based on Jinja, generating type-safe Rust code at compile time.
https://rinja.readthedocs.io
Apache License 2.0
28 stars 4 forks source link

Add versioned book on readthedocs.org #6

Closed Kijewski closed 2 weeks ago

Kijewski commented 3 weeks ago

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 commented 2 weeks ago

Awesome, thanks!

GuillaumeGomez commented 2 weeks ago

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 0.1.0?