Skip to content

Conversation

@pfackeldey
Copy link
Collaborator

This PR updates the docs to:

  • use MyST markdown instead of restructured text (except for API ref; they're a bit fragile right now so I kept them as they are)
  • use a modern theme (pydata)
  • reduce ~200 bugs/typos from existing doc strings
  • add a User Guide section that can be filled with more 'hands-on' docs

@pfackeldey
Copy link
Collaborator Author

The CI doesn't seem to pickup the Makefile from the PR to build the docs... :/

@pfackeldey pfackeldey mentioned this pull request Aug 7, 2025
7 tasks
@lgray
Copy link
Collaborator

lgray commented Aug 27, 2025

I'll poke at this later today or tomorrow to see if I can get RTD consuming it correctly.

@lgray lgray force-pushed the pfackeldey/overhaul_docs branch from 2d51abc to f0929cd Compare August 28, 2025 18:30
@lgray lgray force-pushed the pfackeldey/overhaul_docs branch from f50e9ca to d15bcaf Compare August 28, 2025 18:35
@lgray
Copy link
Collaborator

lgray commented Aug 28, 2025

@pfackeldey OK - it's picking up things correctly now! Have fun :-)

@pfackeldey
Copy link
Collaborator Author

Hi @ikrommyd and @lgray,
I've added quite some content to the docs (with the help of Codex :P). Afterwards I went through manually and adjusted/fixed obvious hallucinations or things that are non-sense, and added some stuff by hand. I do not intend to update the example notebooks with this PR.
Please have a look how you like the docs and the content. Let me know if you want something in addition or different. In principle I would consider this PR done (for now).

@ikrommyd
Copy link
Collaborator

Thanks a ton @pfackeldey! I will take a look as soon as I can.

@ikrommyd ikrommyd marked this pull request as ready for review October 30, 2025 01:36
@ikrommyd ikrommyd changed the title docs: start of updating docs to use MyST docs: update docs to use MyST Oct 30, 2025
Copy link
Collaborator

@ikrommyd ikrommyd left a 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.

@ikrommyd
Copy link
Collaborator

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.

@ikrommyd ikrommyd merged commit 5eb8fd4 into master Oct 30, 2025
23 checks passed
@ikrommyd ikrommyd deleted the pfackeldey/overhaul_docs branch October 30, 2025 05:02
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.

4 participants