-
Notifications
You must be signed in to change notification settings - Fork 112
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Host documentation #250
base: master
Are you sure you want to change the base?
Host documentation #250
Conversation
@IsaccBarker thank you! What changes need to be done, exactly? Pages enabled in what way? |
If I recall correctly from when I set it up on my own repository, you should be able to go to the pages tab in the repository settings page, and select the source to be from Github Actions. You can see above that the docs building succeeded, but the deploy failed. I believe (I don't have access to the logs), this is because the source isn't set to Github Pages. If you change that, I think it should work. Thanks! |
Thanks for the info! I switched the github pages source to github actions, but the CI action still seems to be failing. Anything I'm missing? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can this be retried? It's quite annoying to have to find & jump to a custom fork to read the documentation.
Also don't forget to update Cargo.toml
with a documentation=
link to GitHub pages, and improve the mentions in the readme.
branches: [ "master" ] | ||
pull_request: | ||
branches: [ "master" ] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
branches: [ "master" ] | |
pull_request: | |
branches: [ "master" ] | |
branches: [master] | |
pull_request: | |
branches: [master] |
@@ -0,0 +1,42 @@ | |||
name: Rust |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
name: Rust | |
name: Publish Rust documentation to GitHub pages |
And perhaps rename the file as well?
permissions: | ||
contents: read | ||
pages: write | ||
id-token: write |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These permissions can perhaps be moved to the deploy
job: https://github.com/actions/deploy-pages
steps: | ||
- name: Deploy to GitHub Pages | ||
id: deployment | ||
uses: actions/deploy-pages@v1 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's now v3: https://github.com/actions/deploy-pages
How about updating the PR description with |
See issue #5, specifically here.
GitHub Pages still has to be set up via repository settings, but this should work. It worked on my fork.