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

Docs: migrate tutorials using sphnix-gallery #268

Merged
merged 6 commits into from
Aug 25, 2024

Conversation

superstar54
Copy link
Member

@superstar54 superstar54 commented Aug 24, 2024

This PR migrates the tutorial section to sphnix-gallery. To run calculation using QE, I

  • Install QE using conda
  • Install pseudo-potential using aiida-pseudo

Also, migrate one notebook in howto and built-in task sections.

Note: it's take ~ 10 mins to build the docs now. The maximum time allowed in RTD is 15 minutes. We need to decide which notebooks should move to gallery and which are not.

@superstar54 superstar54 force-pushed the docs/use_sphnix_gallery branch 2 times, most recently from 83a20b2 to 5e87b0c Compare August 24, 2024 08:18
@codecov-commenter
Copy link

codecov-commenter commented Aug 24, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 79.74%. Comparing base (5937b88) to head (e1ba5cc).
Report is 50 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #268      +/-   ##
==========================================
+ Coverage   75.75%   79.74%   +3.98%     
==========================================
  Files          70       65       -5     
  Lines        4615     4897     +282     
==========================================
+ Hits         3496     3905     +409     
+ Misses       1119      992     -127     
Flag Coverage Δ
python-3.11 79.64% <ø> (+3.97%) ⬆️
python-3.12 79.64% <ø> (?)
python-3.9 79.69% <ø> (+3.96%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

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

@superstar54 superstar54 force-pushed the docs/use_sphnix_gallery branch 4 times, most recently from ef0e007 to 0b1006b Compare August 25, 2024 05:18
@superstar54 superstar54 force-pushed the docs/use_sphnix_gallery branch 4 times, most recently from 201d0fc to ccb2e18 Compare August 25, 2024 19:02
@superstar54 superstar54 force-pushed the docs/use_sphnix_gallery branch 3 times, most recently from 5e20aef to c901e06 Compare August 25, 2024 20:23
@superstar54 superstar54 changed the title migrate tutorials Docs: migrate tutorials using sphnix-gallery Aug 25, 2024
@superstar54 superstar54 merged commit c0c801d into main Aug 25, 2024
8 checks passed
This pull request was closed.
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.

2 participants