nlfiedler / magick-rust

Rust bindings for ImageMagick
https://crates.io/crates/magick_rust
Apache License 2.0
246 stars 63 forks source link

Deploy docs to github pages (without storing in repository). #101

Closed 2e0byo closed 1 year ago

2e0byo commented 1 year ago

Github pages now allows you to deploy straight from an action without committing anything to a repo.

This PR adds a workflow which builds the docs for master and then deploys them. It would be possible to checkout all tags and build them all, but a menu would be needed.

The intention is not to substitute for just running cargo doc locally, but to provide something visible online for people (like me!) discovering the library and wanting to glance at the docs before doing anything with it.

Before merging you will need to enable pages in the repository settings, and set the source to 'build with action (beta)'.

Closes #31. (maybe)

2e0byo commented 1 year ago

Demo at https://2e0byo.github.io/magick-rust/.

nlfiedler commented 1 year ago

Okay, I think I enabled the necessary options, let's see how this goes. Thank you for finding a solution to this problem.