boutproject / xBOUT

Collects BOUT++ data from parallelized simulations into xarray.
https://xbout.readthedocs.io/en/latest/
Apache License 2.0
21 stars 10 forks source link

Fix lots of docs issues, autogen API, switch theme #293

Closed ZedThree closed 1 year ago

ZedThree commented 1 year ago

Also update RTD config to v2 (v1 now doesn't work)

codecov-commenter commented 1 year ago

Codecov Report

Merging #293 (ec5ecc1) into master (212b407) will increase coverage by 0.00%. Report is 6 commits behind head on master. The diff coverage is 100.00%.

:exclamation: Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more.

@@           Coverage Diff           @@
##           master     #293   +/-   ##
=======================================
  Coverage   68.94%   68.95%           
=======================================
  Files          15       15           
  Lines        3214     3215    +1     
  Branches      792      792           
=======================================
+ Hits         2216     2217    +1     
  Misses        734      734           
  Partials      264      264           
Files Changed Coverage Δ
xbout/boutdataarray.py 78.35% <ø> (ø)
xbout/boutdataset.py 76.73% <ø> (ø)
xbout/load.py 69.42% <ø> (ø)
xbout/plotting/animate.py 45.37% <ø> (ø)
xbout/region.py 83.59% <100.00%> (+0.03%) :arrow_up:

:mega: We’re building smart automated test selection to slash your CI/CD build times. Learn more

ZedThree commented 1 year ago

I think the failure is because the RTD theme doesn't support the latest sphinx. I'd like to just switch to using the sphinx_book_theme, but installing that will conflict with #294 so that best go in first

dschwoerer commented 1 year ago

Happy to merge it any way, it certainly improves things :+1:

ZedThree commented 1 year ago

Now also switches to sphinx-book-theme and uses autosummary to auto-generate all the API docs.

ZedThree commented 1 year ago

Actually builds on RTD now!