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

Setup of quarto docs #59

Merged

Conversation

gvegayon
Copy link
Member

@gvegayon gvegayon commented Apr 3, 2024

It sets up a GHA that:

  • Installs poetry.
  • Installs pyrenew.
  • Sets up quarto.
  • Renders all documents under model/docs/*.qmd

Eventually, this action could be used to generate the rst documents needed for the website. For the moment, is just a check that the documentation can properly render.

@gvegayon gvegayon linked an issue Apr 3, 2024 that may be closed by this pull request
2 tasks
@gvegayon gvegayon marked this pull request as ready for review April 3, 2024 17:39
.github/workflows/docs.yaml Show resolved Hide resolved
.github/workflows/docs.yaml Outdated Show resolved Hide resolved
.github/workflows/docs.yaml Show resolved Hide resolved
Co-authored-by: Dylan H. Morris <dylanhmorris@users.noreply.github.com>
.github/workflows/docs.yaml Outdated Show resolved Hide resolved
Copy link

codecov bot commented Apr 4, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.80%. Comparing base (ca96421) to head (72d5bad).

❗ Current head 72d5bad differs from pull request most recent head b8ff399. Consider uploading reports for the commit b8ff399 to get more accurate results

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #59   +/-   ##
=======================================
  Coverage   89.80%   89.80%           
=======================================
  Files          26       26           
  Lines         559      559           
=======================================
  Hits          502      502           
  Misses         57       57           
Flag Coverage Δ
unittests 89.80% <ø> (ø)

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.

Copy link
Collaborator

@dylanhmorris dylanhmorris left a comment

Choose a reason for hiding this comment

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

I think this is good to go, but we should continue discussing https://github.com/CDCgov/multisignal-epi-inference/pull/59/files#r1552090213

@dylanhmorris dylanhmorris merged commit ddee419 into main Apr 4, 2024
6 checks passed
@dylanhmorris dylanhmorris deleted the gvegayon/documentation/58-ci-for-rendering-quarto-files branch April 4, 2024 18:00
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.

CI for rendering quarto files
2 participants