Skip to content

ci|docs: automatic docs deployment when merging into develop#269

Merged
FlorianDeconinck merged 1 commit into
NOAA-GFDL:developfrom
romanc:romanc/docs-deploy
Oct 20, 2025
Merged

ci|docs: automatic docs deployment when merging into develop#269
FlorianDeconinck merged 1 commit into
NOAA-GFDL:developfrom
romanc:romanc/docs-deploy

Conversation

@romanc
Copy link
Copy Markdown
Collaborator

@romanc romanc commented Oct 16, 2025

Description

This PR adds the automatic deployment of documentation from the docs/ folder to https://noaa-gfdl.github.io/NDSL with every merge into develop.

@fmalatino: we might need configuration changes (in the repo settings) for this to work. It should be the same as for PyFV3, where we already automatically deploy docs to https://noaa-gfdl.github.io/PyFV3/.

@FlorianDeconinck this will deploy the whole contents of docs/, not just the docstrings. I remember a discussion to bring some of the contents from SMT (e.g. the tutorials) over here before we publish docs. Should we do a pass at the docs/ folder first, before we deploy docs?

How has this been tested?

With #268 merged, we at know that the docs will build. The deployment is untested. However, it's a standard building block and I just copied the workflow from PyFV3 where it already works. If anything fails, then it's likely a configuration issue (and I don't have access rights to check if anything needs to be configured or if things are okay).

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
    N/A
  • My changes generate no new warnings
  • Any dependent changes have been merged and published in downstream modules
  • New check tests, if applicable, are included
    N/A

@romanc romanc force-pushed the romanc/docs-deploy branch from 84cc248 to 3714b84 Compare October 18, 2025 06:06
@romanc romanc marked this pull request as ready for review October 18, 2025 06:25
Copy link
Copy Markdown
Collaborator

@FlorianDeconinck FlorianDeconinck left a comment

Choose a reason for hiding this comment

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

📖

@FlorianDeconinck FlorianDeconinck added this pull request to the merge queue Oct 20, 2025
Merged via the queue into NOAA-GFDL:develop with commit 3ffbcba Oct 20, 2025
6 checks passed
@romanc romanc deleted the romanc/docs-deploy branch October 20, 2025 21:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Scheduled for next Release To be merged before the next release

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants