MetOffice / MetOffice/ProFSea-tool
`profsea-climate` - Add documentation
@isabellaascione is already working on this.
Since Apr 1, 2026.
- Dominant language
- Python
- Stars
- 6
- Forks
- 11
- Avg merge
- 13h 34m
- Merged PRs (30d)
- 2
Description
A great next step with ProFSea would be to add comprehensive documentation for users and future developers.
Steps here include:
- Create a PR with locally-buildable documentation (using Sphinx, or VitePress for something nice and modern?)
- Ensure all functions and classes have appropriate and informative docstrings, and general code is usefully commented
- All functions/classes use appropriate type hints
- Example code blocks and expected outputs (sample plots, etc.)
- A `Home` and `Install` page for ProFSea, appropriate for both users and developers.
Soon, we should aim to set up GitHub Actions in order to deploy the documentation to a webpage, and aim to get ProFSea onto Conda and Pypi!
@hmkhatri anything else you can think of to get started?
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.