Skip to content

Profsea v3 adding documentation to profsea software#67

Merged
Hemant Khatri (hmkhatri) merged 2 commits into
MetOffice:profsea-v3from
isabellaascione:profsea-v3
Jun 10, 2026
Merged

Profsea v3 adding documentation to profsea software#67
Hemant Khatri (hmkhatri) merged 2 commits into
MetOffice:profsea-v3from
isabellaascione:profsea-v3

Conversation

@isabellaascione

Copy link
Copy Markdown
Collaborator

related to #65

replaces #47 because target has changed to profsea-v3.

This PR includes:

  • Enabled documentation build and deployment to GitHub Pages using Sphinx.
  • Added and organized documentation pages for the User Guide, Development Guidelines, tutorial notebooks, and guidance for updating the Sphinx docs.
  • Added API reference generation from docstrings.
  • Enabled rendering of existing Jupyter notebooks in the Sphinx documentation.

the output docs can be previewed at the following link :

https://isabellaascione.github.io/ProFSea-tool/

The PR needs to be reviewed

…dated names of branches to refer to profsea and not to profsea-climate; build docs from profsea-v3
@isabellaascione

Copy link
Copy Markdown
Collaborator Author

note that the following line needs to be changed to build from the main when profsea-v3 is merged with the main.

https://github.com/isabellaascione/ProFSea-tool/blob/profsea-v3/.github/workflows/deploy-docs.yml#L8

@isabellaascione isabellaascione added the documentation 📜 Improvements or additions to documentation label Jun 8, 2026
@gregrmunday

Greg Munday (gregrmunday) commented Jun 10, 2026

Copy link
Copy Markdown
Collaborator

Looks good to me, thanks isabellaascione! I'm happy to merge if you are Hemant Khatri (@hmkhatri)?

@hmkhatri

Copy link
Copy Markdown
Collaborator

isabellaascione Greg Munday (@gregrmunday) Thank you both. I will merge it now.

@hmkhatri Hemant Khatri (hmkhatri) merged commit c70fe95 into MetOffice:profsea-v3 Jun 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation 📜 Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants