meta: CI publishes docs on master builds to GitHub Pages #210
Labels
Comments
hawkw
added a commit
that referenced
this issue
Aug 14, 2019
## Motivation Currently, we link to RustDoc on docs.rs. This is built when a crate is published to crates.io. In some cases, it is also valuable to publish the documentation for the latest `master` branch, so that users using git dependencies can see up to date docs. ## Solution This branch adds a GitHub action that will build docs & publish them to the `gh-pages` branch when source files change. Closes: #210 * add pages publish action on master commits * only rebuild when sources change Signed-off-by: Eliza Weisman <[email protected]>
|
The github action doesn't work. |
hawkw
pushed a commit
that referenced
this issue
Sep 4, 2019
chore: build and publish documentation for each branch. This commit introduces support for: - building and deploying documentation for the master branch - building and deploying (preview) documentation for each pull request and for each PR - adds a link in `README.md` pointing to the generated documentation for the master branch - notes the per-PR documentation previews in `CONTRIBUTING.md` Closes #210
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Feature Request
Motivation
It would be nice to auto-publish the master docs every time a commit is merged to master. This is especially helpful as there are a number of incubating nursery crates which have not been published to crates.io, and thus don't get published to docs.rs, but still see some use.
Proposal
I believe crate-ci/azure-pipelines#35 is tracking an upstream change to the CI configs that should hopefully make this easy. When that lands, we should add it to our build.
The text was updated successfully, but these errors were encountered: