Conversation
tsibley
approved these changes
May 3, 2022
Contributor
There was a problem hiding this comment.
Looks good to me to start with the specific use in the ncov repo. For broader use (which would be great), I think we'd want to:
- Make the Conda setup optional. Not all our repos use Conda for the docs build, and it my experience it seems to result in slower docs builds than pip. (IIRC, this also means we'd want to make the
run.shellbit conditional onsetup-miniconda, as that's the thing that restores-euo pipefailto the shell invocation another way.) - Make the doc format (make target) configurable, as some repos use
dirhtml.
victorlin
force-pushed
the
victorlin/add-docs-ci
branch
from
3623a1b to
6789fbe
Compare
This parallels the motivation behind 6245d9e for pathogen repo CI, but for repos containing Sphinx documentation. As a starting point, the reusable workflow fails on build warnings such as invalid links and bad formatting.
victorlin
force-pushed
the
victorlin/add-docs-ci
branch
from
6789fbe to
a65c1b2
Compare
victorlin
commented
May 3, 2022
tsibley
approved these changes
May 3, 2022
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description of proposed changes
This parallels the motivation behind 6245d9e for pathogen repo CI, but for repos containing Sphinx documentation.
As a starting point, the reusable workflow fails on build warnings such as invalid links and bad formatting.
Related issue(s)
N/A
Testing
See nextstrain/ncov#941