Skip to content

profsea-climate - Add documentation #46

@gregrmunday

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!

Hemant Khatri (@hmkhatri) anything else you can think of to get started?

Metadata

Metadata

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions