docs: migrate from readme to docs #90
Merged
Conversation
This file contains hidden or 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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #90 +/- ##
=======================================
Coverage 75.27% 75.27%
=======================================
Files 4 4
Lines 1630 1630
=======================================
Hits 1227 1227
Misses 403 403 ☔ View full report in Codecov by Sentry. |
Member
|
I tried to add a badge in #89 |
ianna
commented
Mar 14, 2024
Member
Author
ianna
left a comment
ianna
left a comment
There was a problem hiding this comment.
@jpivarski - is it ok if I restructure the index.md or would you like to do it yourself? Thanks!
| * `AwkwardArray.from_buffers`: constructs an Awkward Array from a Form (JSON), length, and buffers for zero-copy passing from Python | ||
| * `AwkwardArray.to_buffers`: deconstructs an Awkward Array into a Form (JSON), length, and buffers for zero-copy passing to Python | ||
|
|
||
| _(This will turn into proper documentation, eventually.)_ |
Member
Author
There was a problem hiding this comment.
@jpivarski - the idea is to trim the top README.md file and have full documentation here that is generated as a documentation by Documeter.jl. The full infrastructure is already in place. The dev version of documentation is at https://juliahep.github.io/AwkwardArray.jl/dev/
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.
No description provided.