search

mehta-lab / microDL

3D virtual staining with 2D and 2.5D U-Nets
BSD 3-Clause "New" or "Revised" License
27 stars 7 forks source link

Actions docs #194

Closed jennyfolkesson closed 1 year ago

jennyfolkesson commented 1 year ago

I decided to go with the following for creating a github actions workflow for autopublishing docs: https://github.com/peaceiris/actions-gh-pages

In my last push I updated the action to only trigger when there's a push to main (which I haven't been able to test), but I've been testing it with this branch and it seems to be working, so hopefully this will work.

I've also added some notes in the docs/readme.md on how to build the html locally and with the workflow.

I've set up a branch named gh-pages where changes in documentation will be pushed to and automatically published from.

Latest version can be seen here: https://mehta-lab.github.io/microDL

Thank you for giving me permissions to change the Pages settings in order to set this up. I appreciate your help and feedback.

codecov-commenter commented 1 year ago

Codecov Report

Merging #194 (d01e227) into main (91da099) will not change coverage. The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #194   +/-   ##
=======================================
  Coverage   76.75%   76.75%           
=======================================
  Files          53       53           
  Lines        5090     5090           
=======================================
  Hits         3907     3907           
  Misses       1183     1183
Flag Coverage Δ
build 76.75% <ø> (ø)

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

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 91da099...d01e227. Read the comment docs.

jennyfolkesson commented 1 year ago

This PR is ready for another review. I've tested it using the actions_docs.yml workflow seen here: https://github.com/mehta-lab/microDL/pull/194/commits/698c03aa27b3004ea4886c5c85194443619dfb04 and I'm assuming the behavior will be the same now that I've switched the branch that triggers the action to main. Thanks.