euroargodev / euroargodev/argopy

Update "Contributing to argopy" on Documentation

Open
#469 1 comment 0 reactions 0 assignees View on GitHub
documentation good-practices stale
Dominant language
Python
Stars
229
Forks
52
Avg merge
2d 10h
Merged PRs (30d)
8

Description

With a couple of new internal mechanisms to manage extensions, and going ahead of the 2025 training camps, I think we need to revisit and update the "Contributing to argopy" page on our documentation:

https://argopy.readthedocs.io/en/latest/contributing.html

This update should include:

- [ ] a new section about the [Argo accessor extension mechanism](https://argopy.readthedocs.io/en/latest/api.html#dataset-argo-xarray-accessor)
- [ ] an update to the [development environment section](https://argopy.readthedocs.io/en/latest/contributing.html#virtual-environment)

Contributor guide

Open the contributing guide

Research direction

Start with the Contributing to argopy page at contributing.html, then read the linked Argo accessor extension documentation in api.html and the existing virtual environment section. Update the page with the extension mechanism and current development-environment guidance; done means both requested sections are complete and the documentation links and examples are accurate.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
Half a day
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.