Added quartodoc build stage to the quato-render runner so that API reference pages are built in the gh-pages branch. Fixes #281.
Also fixed a minor issue with README.md by migrating the 'Reder Docs' badge to track the quarto-render runner.
Motivation and Context
Resolve issue #281
Type of change
[X] Bug fix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
How Has This Been Tested?
Unable to test locally since it's a runner issue and the PR must be merged to dev or main to trigger. However, this stage was previously missing and needs to be added to ensure the API reference .qmd files are available before the quarto build steps.
Advice for reviewer
None
Checklist:
[X] My code follows the intended structure of this project
[X] I have performed a self-review of my own code
[X] I have commented my code, particularly in hard-to-understand areas
[X] I have made corresponding changes to the documentation
[X] My changes generate no new warnings
[ ] I have added tests that prove my fix is effective or that my feature works
[X] New and existing unit tests pass locally with my changes
[X] Any dependent changes have been merged and published in downstream modules
Description
Added
quartodoc build
stage to thequato-render
runner so that API reference pages are built in thegh-pages
branch. Fixes #281.Also fixed a minor issue with
README.md
by migrating the 'Reder Docs' badge to track thequarto-render
runner.Motivation and Context
Resolve issue #281
Type of change
How Has This Been Tested?
Unable to test locally since it's a runner issue and the PR must be merged to
dev
ormain
to trigger. However, this stage was previously missing and needs to be added to ensure the API reference.qmd
files are available before the quarto build steps.Advice for reviewer
None
Checklist:
Additional comments
None