Add documentation via Documenter.jl #56
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
giordano
reviewed
Sep 20, 2023
Co-authored-by: Mosè Giordano <giordano@users.noreply.github.com>
Codecov Report
@@ Coverage Diff @@
## master #56 +/- ##
=======================================
Coverage 88.05% 88.05%
=======================================
Files 2 2
Lines 134 134
=======================================
Hits 118 118
Misses 16 16 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
Co-authored-by: Mosè Giordano <giordano@users.noreply.github.com>
|
I changed the job name to |
|
Awesome! Let's see if it works! |
Closed
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.
This partially addresses #27.
After having to navigate to the sources of Preferences.jl for the umpteenth time because I forgot the details of the non-macro API, I decided to add Documenter.jl-based documentation. In addition, I added some small bits and pieces to the docs (such as an author and license section).
@staticfloat It would be great if you could set up the
DOCUMENTER_KEYsecret as described in the Documenter.jl docs & review this PR at your convenience. If you want only the bare minimum docs and not the additional changes I made, I can also revert some of them.