-
Notifications
You must be signed in to change notification settings - Fork 135
docs: update docs to use MyST #1391
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
Conversation
|
The CI doesn't seem to pickup the Makefile from the PR to build the docs... :/ |
|
I'll poke at this later today or tomorrow to see if I can get RTD consuming it correctly. |
2d51abc to
f0929cd
Compare
f50e9ca to
d15bcaf
Compare
|
@pfackeldey OK - it's picking up things correctly now! Have fun :-) |
|
Hi @ikrommyd and @lgray, |
|
Thanks a ton @pfackeldey! I will take a look as soon as I can. |
ikrommyd
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I can't manually review this large diff of course line by line but this PR does not touch actual code. It only touches docstrings and docs. No tests touches too. I therefore think that we can trust it cannot break user code.
I myself threw some LLMs at overall doc formatting and docstring formatting of the codebase too. The coffea docs now look much better than they used to so I think it's safe to merge this.
|
Thanks a lot @pfackeldey! It's already a pretty huge PR. The docs are not perfect but this is already a great improvement. I'm merging it and we can go from there in separate PRs for improvements. |
This PR updates the docs to:
User Guidesection that can be filled with more 'hands-on' docs