Refactor Sphinx documentation build workflow and update requirements file - #20
Conversation
|
I shouldn't review this PR. Think Andrew Coughtrie (@andrewcoughtrie) can find some time to review it. Pierre Siddall (@Pierre-siddall) as discussed, if you can update the README file to clarify the Requirements file section and add another section to to show how this action can be used alongside deploy pages action. |
I agree I'll switch this PR into draft mode for now while I tackle these items before they head into review from Andrew Coughtrie (@andrewcoughtrie) . |
|
I think it would be ideal to set a default timeout-minutes timeout:
description: "Timeout minutes for the job"
default: 5 # or maybe 10
type: number
required: false |
|
After discussion between Yaswant Pradhan (@yaswant) and I this looks like it's ready to be reviewed. Over to Andrew Coughtrie (@andrewcoughtrie) for CR. |
|
Andrew Coughtrie (@andrewcoughtrie) - do you have some time to review this quickly please? |
Andrew Coughtrie (andrewcoughtrie)
left a comment
There was a problem hiding this comment.
Looks good, some suggested changes to the README.md.
Co-authored-by: Andrew Coughtrie <24609575+andrewcoughtrie@users.noreply.github.com>
Co-authored-by: Andrew Coughtrie <24609575+andrewcoughtrie@users.noreply.github.com>
👍 Co-authored-by: Andrew Coughtrie <24609575+andrewcoughtrie@users.noreply.github.com>
Co-authored-by: Andrew Coughtrie <24609575+andrewcoughtrie@users.noreply.github.com>
Co-authored-by: Andrew Coughtrie <24609575+andrewcoughtrie@users.noreply.github.com>
Co-authored-by: Andrew Coughtrie <24609575+andrewcoughtrie@users.noreply.github.com>
Co-authored-by: Andrew Coughtrie <24609575+andrewcoughtrie@users.noreply.github.com>
I think this section can be expanded like a man page, maybe in a separate PR. Co-authored-by: Andrew Coughtrie <24609575+andrewcoughtrie@users.noreply.github.com>
Co-authored-by: Andrew Coughtrie <24609575+andrewcoughtrie@users.noreply.github.com>
Andrew Coughtrie (andrewcoughtrie)
left a comment
There was a problem hiding this comment.
This all looks good to me now.
a3728a0
into
MetOffice:main
I've refactored the workflow slightly. Also, added sphinx-lint (this needs to be addressed first before compiling the docs)