Use Jupyter Book for documentation. #65
Conversation
Type-promoting aggregators (e.g., summing bools returns int) may give incorrect results with same-type target inference. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Verify that: - aggregator_return_type is ignored when set_annotations=False - No inference or warnings occur when set_annotations=False Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
…ch has proper typing).
…/dags into buid-docs-using-pixi
hmgaudecker
force-pushed
the
use-jb-for-docs
branch
from
3f731b3 to
cf881f5
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #65 +/- ##
=======================================
Coverage 95.57% 95.57%
=======================================
Files 23 23
Lines 1174 1174
=======================================
Hits 1122 1122
Misses 52 52 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
|
I much prefer the JB-based version over the Sphinx-based one. Differences:
But no big deal if we went back to #63 |
|
Switching to Jupyterbook is ok and the new page does look better. However, I would keep the API docs in. It's almost zero cost to have it and I do use online API docs sometimes. Does Jupyterbook have a good way of producing an llms.txt? If we touch the docs this would be the right time to add it. |
|
Is it okay to postpone API docs until this one is there? jupyter-book/mystmd#1259 Would much prefer that over using Sphinx for now and then porting. Writing native MyST is so much nicer! |
timmens
left a comment
timmens
left a comment
There was a problem hiding this comment.
I don't have the capacity to give you a detailed review right now (still sick), but I think switching to JB is nice. I do share Janos view that having the API docs online is nice, but as long as this is an "open issue" that will be tackled in the future I would be okay with this PR as is. In optimagic we build the llms.txt file automatically using sphinx-llms. I am not sure how yours was build but automating this could be an improvement.
No description provided.