Skip to content

Refactor Sphinx documentation build workflow and update requirements file - #20

Merged
Andrew Coughtrie (andrewcoughtrie) merged 18 commits into
MetOffice:mainfrom
yaswant:sphinx-docs
Nov 12, 2025
Merged

Refactor Sphinx documentation build workflow and update requirements file#20
Andrew Coughtrie (andrewcoughtrie) merged 18 commits into
MetOffice:mainfrom
yaswant:sphinx-docs

Conversation

@yaswant

Copy link
Copy Markdown
Collaborator

I've refactored the workflow slightly. Also, added sphinx-lint (this needs to be addressed first before compiling the docs)

@yaswant

Copy link
Copy Markdown
Collaborator Author

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.

@Pierre-siddall

Copy link
Copy Markdown
Contributor

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) .

@Pierre-siddall
Pierre Siddall (Pierre-siddall) marked this pull request as draft November 6, 2025 11:43
@Pierre-siddall Pierre Siddall (Pierre-siddall) added documentation Changes to documentation, including comments and docstrings enhancement labels Nov 6, 2025
@yaswant

Copy link
Copy Markdown
Collaborator Author

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

@Pierre-siddall
Pierre Siddall (Pierre-siddall) marked this pull request as ready for review November 10, 2025 15:03
@Pierre-siddall

Copy link
Copy Markdown
Contributor

After discussion between Yaswant Pradhan (@yaswant) and I this looks like it's ready to be reviewed. Over to Andrew Coughtrie (@andrewcoughtrie) for CR.

@yaswant

Copy link
Copy Markdown
Collaborator Author

Andrew Coughtrie (@andrewcoughtrie) - do you have some time to review this quickly please?

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Looks good, some suggested changes to the README.md.

Comment thread build-sphinx-docs/README.md Outdated
Comment thread build-sphinx-docs/README.md Outdated
Comment thread .github/workflows/build-sphinx-docs.yaml Outdated
Comment thread build-sphinx-docs/README.md Outdated
Comment thread build-sphinx-docs/README.md Outdated
Comment thread build-sphinx-docs/README.md Outdated
Comment thread build-sphinx-docs/README.md Outdated
Comment thread build-sphinx-docs/README.md Outdated
Comment thread build-sphinx-docs/README.md Outdated
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>
@yaswant Yaswant Pradhan (yaswant) added CI and removed documentation Changes to documentation, including comments and docstrings enhancement labels Nov 12, 2025

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This all looks good to me now.

@andrewcoughtrie
Andrew Coughtrie (andrewcoughtrie) merged commit a3728a0 into MetOffice:main Nov 12, 2025
2 checks passed
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.

4 participants