docs: Add automatic docs with pkgdown #8
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
If this is not done, the reference index breaks and pkgdown can't find the package's functions (in this case, function).
* main: docs: readme hex logo refactor: splits main logic into multiple steps and introduces caching
|
@jvfe thank you very much. I am not entirely familiar with pkgdown deployment. Is it ready for merging? Looks good to me.
|
Should be, yes. The setup is really simple and I've already added a GH action that should build and deploy the website after every push. |
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.
chore: Add to ignore files
docs: Add basic DESCRIPTION slots
feat: Add pkgdown config
fix: Separate function and package doc
Addresses discussion in Nonpriority roadmap #5 (comment)