Initial setup of docs #51
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
Using the following steps: ``` (docs) pkg> rm Documenter (docs) pkg> resolve (docs) pkg> add Documenter ```
Based on guidance in `Documenter.jl` docs (at v1.3.0).
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #51 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 12 11 -1
Lines 258 309 +51
=========================================
+ Hits 258 309 +51 ☔ View full report in Codecov by Sentry. |
Run from the package root directory: ``` julia --project=docs -e 'using LiveServer; servedocs()' ```
|
Much more work to be done on writing documentation, but going ahead and merging since this gets us started! Some test failures, but those are likely unrelated (this only touched |
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.
Work on #7