scikit-hep
docs: add user-guide for header-only layout builder
Codecov Report
Merging #1628 (4f5d6f9) into docs (13eb698) will increase coverage by
2.10%. The diff coverage isn/a.
:exclamation: Current head 4f5d6f9 differs from pull request most recent head fa199af. Consider uploading reports for the commit fa199af to get more accurate results
Additional details and impacted files
![codecov[bot] avatar](https://avatars.githubusercontent.com/in/254?v=4 "Published by a pub.dev verified publisher"){kind=small}
@ianna Should I also add the dump() method to print the output to show the buffer contents?
@ianna Should I also add the
dump()method to print the output to show the buffer contents?
I don't think it is needed here. You have a link to the example in c++.
As discussed in our meeting, we'll drop cling here as it's not hugely motivated.
As discussed today, I just need a readable copy of the text to send to the ctapipe developers; this PR can be merged later. It looks to me like I can just use this file:
https://github.com/scikit-hep/awkward/blob/manasvi/layout-builder-user-guide/docs-sphinx/user-guide/how-to-use-header-only-layoutbuilder.md
(They can read markdown.) Is that it? I plan to send this to them by email.
As discussed today, I just need a readable copy of the text to send to the ctapipe developers; this PR can be merged later. It looks to me like I can just use this file:
https://github.com/scikit-hep/awkward/blob/manasvi/layout-builder-user-guide/docs-sphinx/user-guide/how-to-use-header-only-layoutbuilder.md
(They can read markdown.) Is that it? I plan to send this to them by email.
Yes. This can be used. If I am right, I think PR is failing due to some issues on the CI side for running the C++ code blocks but that shouldn't be any issue if we are going to send only the Markdown file.
Please let me know if anything else needs to be added in the user-guide. Should I also add instructions about Awkward installation and compiler flag options like Ianna mentioned? I wasn't sure how to add the instructions for that.
Thanks.
@jpivarski here's an HTML rendered variant of @ManasviGoyal's docs: index.html.txt
The default PDF export was less appealing than the HTML generation (I used the single-document exporter which doesn't use Sphinx). I can render a PDF if needs be, though.
Hi, @agoose77 I have added a few changes. Please have a look in case anything needs to fixed.
Are they any other changes pending for this PR?
@ManasviGoyal my force-push alias was set to git push --force instead of git push --force-with-lease ... so I managed to overwrite your changes. Sorry! I recovered a single commit (the old HEAD) 5f06f73, could you confirm that you only added a single commit, and it was 5f06f73? I suggest not pulling this branch until you're confident it's correct! :)
@ManasviGoyal my force-push alias was set to
git push --forceinstead ofgit push --force-with-lease... so I managed to overwrite your changes. Sorry! I recovered a single commit (the old HEAD) 5f06f73, could you confirm that you only added a single commit, and it was 5f06f73? I suggest not pulling this branch until you're confident it's correct! :)
yes it is only one commit - 5f06f73