Skip to content
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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Conversation

IsaccBarker
Copy link
Contributor

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.

@IsaccBarker IsaccBarker changed the title Documentation generation Host documentation Dec 10, 2022
@kvark
Copy link
Member

kvark commented Dec 26, 2022

@IsaccBarker thank you! What changes need to be done, exactly? Pages enabled in what way?

@IsaccBarker
Copy link
Contributor Author

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.

Skærmbillede 2022-12-25 kl  11 53 27 PM

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!

@kvark
Copy link
Member

kvark commented Dec 27, 2022

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?

Copy link

@MarijnS95 MarijnS95 left a 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.

Comment on lines +5 to +7
branches: [ "master" ]
pull_request:
branches: [ "master" ]

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
branches: [ "master" ]
pull_request:
branches: [ "master" ]
branches: [master]
pull_request:
branches: [master]

@@ -0,0 +1,42 @@
name: Rust

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
name: Rust
name: Publish Rust documentation to GitHub pages

And perhaps rename the file as well?

Comment on lines +10 to +13
permissions:
contents: read
pages: write
id-token: write

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@MarijnS95
Copy link

How about updating the PR description with Fixes #5 fixes #276?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants