This repository has been archived by the owner on Nov 15, 2023. It is now read-only.
Publish rustdocs to github pages #562
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
TriplEight
suggested changes
Aug 9, 2021
Co-authored-by: Denis Pisarev <denis.pisarev@parity.io>
TriplEight
approved these changes
Aug 9, 2021
|
@TriplEight Have you adjusted the repo settings so that the published rustdocs will actually be available at paritytech.github.io/cumulus ? Or if not, could you? |
|
Yeah, I did. Not sure though where is it supposed to host the docs from, for now it's set to |
TriplEight
reviewed
Aug 9, 2021
| with: | ||
| github_token: ${{ secrets.GITHUB_TOKEN }} | ||
| publish_branch: gh-pages | ||
| publish_dir: ./target/doc |
There was a problem hiding this comment.
I'm not sure if ./target/doc is correct, but let's try. GitHub has no other choice but ./root/ or ./docs and the Action's doc (which should be compatible) says it should be ./public.
There was a problem hiding this comment.
This is the directory where cargo doc builds the docs to. ./public is an example.
slumber
pushed a commit
that referenced
this pull request
Sep 1, 2021
* Publish rustdocs to github pages * @TriplEight 's suggestions from code review Co-authored-by: Denis Pisarev <denis.pisarev@parity.io> Co-authored-by: Denis Pisarev <denis.pisarev@parity.io>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
This PR adds a CI job that builds and published the rustdocs to github pages. Similar to crates.parity.io, https://paritytech.github.io/frontier/rustdocs/pallet_evm/, or https://purestake.github.io/moonbeam/moonbeam_runtime/index.html
This is useful when working on downstream code to have an API guide quickly available, especially since github will host it for free.
This will need a little bit of help from someone with some permissions on this repo to setup the publishing source as the
gh-pagesbranch. docs