Feature/add auto documentation #30
Open
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
REMINDER!! |
dotunwrap
reviewed
May 18, 2024
dotunwrap
added
documentation
dotunwrap
reviewed
Jun 9, 2024
| - name: Build docs | ||
| run: cargo doc | ||
| - name: Add redirect | ||
| run: echo '<meta http-equiv="refresh" content="0;url=credit_card_convenience/index.html">' > target/doc/index.html |
There was a problem hiding this comment.
What is the significance of credit_card_convenience/index.html?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
I am requesting a pull into the master branch, but for good reason I think.
The only updates in this pr are twofold,
1st, An update to the readme.md with a little badge that says documentation that contains a hyperlink to the MOST LIKELY URL for the documentation (I had to guess at this since I don't have access to your account, but it should probably work)
2nd, a new github actions workflow has been added to the folder, its rather simple I think but I got it running on some other code, basically it will automatically run 'cargo doc' and then take the generated website and throw it into github pages.
NOTE: SETTINGS MIGHT NEED MODIFICATION on the repo's settings panel make sure that github pages has its source set to "Github Actions" This needs to be done PRIOR TO MERGING