Skip to content
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

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

Merged
merged 12 commits into from
Jul 27, 2023
Merged

Conversation

ZedThree
Copy link
Member

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

@ZedThree ZedThree requested a review from dschwoerer July 26, 2023 09:48
@codecov-commenter
Copy link

codecov-commenter commented Jul 26, 2023

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%.

❗ 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%) ⬆️

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

Copy link
Contributor

@dschwoerer dschwoerer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good.
The build still fails, I'm having a look

xbout/boutdataarray.py Show resolved Hide resolved
@ZedThree
Copy link
Member Author

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
Copy link
Contributor

Happy to merge it any way, it certainly improves things 👍

@ZedThree
Copy link
Member Author

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

@ZedThree ZedThree changed the title Fix lots of docs issues Fix lots of docs issues, autogen API, switch theme Jul 27, 2023
@ZedThree
Copy link
Member Author

Actually builds on RTD now!

Copy link
Collaborator

@johnomotani johnomotani left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me. Thanks @ZedThree!

@ZedThree ZedThree merged commit 4f82355 into master Jul 27, 2023
@ZedThree ZedThree deleted the fix-rtd-config branch July 27, 2023 12:49
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