Add documentation via Documenter.jl #56
Merged
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_KEY
secret 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.