mozilla / uniffi-rs

a multi-language bindings generator for rust
https://mozilla.github.io/uniffi-rs/
Mozilla Public License 2.0
2.48k stars 211 forks source link

Deploy the docs site using mike #2139

Closed mhammond closed 1 month ago

mhammond commented 1 month ago

I'm not 100% sure this actually works, but reading the circle docs and looking at jj it seems like it should.

mhammond commented 1 month ago

Still not clear if it actually works and will not be until a docs change is pushed. CI for the job shows:

INFO    -  Cleaning site directory
INFO    -  Building documentation to directory: /home/circleci/project/target/rendered-docs
INFO    -  The following pages exist in the docs directory, but are not included in the "nav" configuration:
  - index.md
WARNING -  Doc file 'tutorial/foreign_language_bindings.md' contains a link '../Overview.md', but the target 'Overview.md' is not found among documentation files.
INFO    -  Documentation built in 0.77 seconds
warning: nothing changed in commit
  To create a commit anyway, retry with --allow-empty

which is what I expected. I guess I should just put a PR up to fix that warning and see what happens :)

Note that the gh-pages branch is correctly deployed though, so the versioning is all in place.