Use Jupyter Book for documentation.

[hmgaudecker]

No description provided.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.46%. Comparing base (1eb4af0) to head (0ac1675).

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #65      +/-   ##
==========================================
- Coverage   95.53%   95.46%   -0.07%     
==========================================
  Files          25       25              
  Lines        1187     1169      -18     
==========================================
- Hits         1134     1116      -18     
  Misses         53       53              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[review-notebook-app]

Check out this pull request on 

See visual diffs & provide feedback on Jupyter Notebooks.

---

Powered by ReviewNB

[hmgaudecker]

@timmens @janosg

I much prefer the JB-based version over the Sphinx-based one. Differences:

• I improved the usage patterns page a bit in the JB version
• No API docs in JB. My view: Nobody looks at them online anymore, all introspection in the editor / asking AI)

But no big deal if we went back to #63

[janosg]

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.

[hmgaudecker]

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]

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.