Skip to content
This repository has been archived by the owner on Jul 29, 2023. It is now read-only.

Actions docs #194

Merged
merged 53 commits into from
Jan 10, 2023
Merged

Actions docs #194

merged 53 commits into from
Jan 10, 2023

Conversation

jennyfolkesson
Copy link
Contributor

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

codecov-commenter commented Dec 22, 2022

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.

docs/source/index.rst Outdated Show resolved Hide resolved
@jennyfolkesson jennyfolkesson removed the request for review from mattersoflight December 28, 2022 04:48
@jennyfolkesson jennyfolkesson marked this pull request as draft December 28, 2022 04:49
@jennyfolkesson jennyfolkesson marked this pull request as ready for review December 30, 2022 22:49
@jennyfolkesson
Copy link
Contributor Author

This PR is ready for another review. I've tested it using the actions_docs.yml workflow seen here:
698c03a
and I'm assuming the behavior will be the same now that I've switched the branch that triggers the action to main. Thanks.

@jennyfolkesson jennyfolkesson merged commit 0420d46 into main Jan 10, 2023
@jennyfolkesson jennyfolkesson deleted the actions_docs branch January 10, 2023 20:23
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants