ci(docs): add workflow for auto. doc generation #28
Conversation
This file contains hidden or 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
added 2 commits
July 15, 2020 13:39
This PR adds a GitHub Actions workflow file to automatically generate documentation for each push to the master branch. The documentation is pushed to the `gh-pages` branch.
mainrs
commented
Jul 15, 2020
| # pre | ||
|
|
||
| [docs_master_badge]: https://img.shields.io/badge/docs.rs-master-green | ||
| [docs_master_url]: https://aticu.github.io/pre |
Contributor
Author
There was a problem hiding this comment.
You'd have to change the docs_master_url if you have already a personal GitHub Pages website that points to a custom URL using CNAME or similar.
Take a look at https://raw.githubusercontent.com/SirWindfield/twm/master/README.md, which does exactly this.
Owner
|
Thanks! I have never used GitHub Pages before. I'll look into it when I have the time (most likely after the thesis is due). |
Contributor
Author
|
No problem! IIRC it should actually work out of the box :) And good luck with your thesis :) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 GitHub Actions workflow file to automatically generate documentation for each push to the master branch. The documentation is pushed to the
gh-pagesbranch. The code is taken from a GitHub template that I use for my libraries: https://github.com/SirWindfield/zerotask-rust-lib-template