Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fix kernel generation #1800

Merged
merged 1 commit into from
Oct 20, 2022
Merged

docs: fix kernel generation #1800

merged 1 commit into from
Oct 20, 2022

Conversation

agoose77
Copy link
Collaborator

@agoose77 agoose77 commented Oct 17, 2022

This PR addresses one of the issues in #1799; fixing the kernel docs.


📚 The documentation for this PR will be available at https://awkward-array.readthedocs.io/en/agoose77-docs-touchups/ once Read the Docs has finished building 🔨

@codecov
Copy link

codecov bot commented Oct 17, 2022

Codecov Report

Merging #1800 (b5a8080) into main (569f183) will decrease coverage by 0.01%.
The diff coverage is n/a.

❗ Current head b5a8080 differs from pull request most recent head f42b113. Consider uploading reports for the commit f42b113 to get more accurate results

Additional details and impacted files
Impacted Files Coverage Δ
src/awkward/operations/ak_run_lengths.py 90.32% <0.00%> (-0.31%) ⬇️
src/awkward/contents/indexedarray.py 79.76% <0.00%> (-0.19%) ⬇️
src/awkward/contents/recordarray.py 83.72% <0.00%> (-0.18%) ⬇️
src/awkward/_util.py 82.36% <0.00%> (-0.18%) ⬇️
src/awkward/contents/indexedoptionarray.py 88.92% <0.00%> (-0.16%) ⬇️
src/awkward/_connect/avro.py 87.17% <0.00%> (-0.14%) ⬇️
src/awkward/types/_awkward_datashape_parser.py 47.72% <0.00%> (-0.01%) ⬇️
src/awkward/_connect/cling.py 24.90% <0.00%> (ø)
src/awkward/contents/content.py 77.31% <0.00%> (+0.10%) ⬆️

@agoose77 agoose77 marked this pull request as ready for review October 18, 2022 19:54
@agoose77 agoose77 changed the title docs: follow-ups from #1776 docs: fix kernel generation Oct 18, 2022
@jpivarski
Copy link
Member

Same as #1810 (comment). I could run Sphinx locally and view the rendered HTML locally, but that's probably what you're doing, and the real test of what it looks like is what ReadTheDocs makes of it. It might be too cumbersome to make ReadTheDocs render every documentation-related PR or branch, but we could do a two-step PR of (1) develop in a new branch, (2) pull that into the docs branch, and (3) request the docs branch to be merged into main. The downside of this is that there can't be concurrent PRs (or I would see them all in their already-merged state), but the documentation isn't currently being developed in parallel. (And later, when things settle down, it would be mostly changes to the text, which doesn't have to be reviewed in-situ.)

@agoose77
Copy link
Collaborator Author

@jpivarski this is now ready to go!

@jpivarski
Copy link
Member

Fantastic! I just took a look, and it looks great.

@jpivarski jpivarski merged commit 38243b2 into main Oct 20, 2022
@jpivarski jpivarski deleted the agoose77/docs-touchups branch October 20, 2022 21:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants