docs: Add doc build to CI for GH pages #50
Merged
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.
A stop gap until we figure out what to do with regards to docs.rs. The
documentation
key inCargo.toml
means crates.io docs button will point to our gh pages link, instead of docs.rs. This has almost all the same features as using docs.rs, however we won't have past versions documentation available once a new version is published.Currently I've set it to only deploy with releases.
sidenote: I'll be very shocked if this works first time so expect a follow up PR :D