pypsa-meets-earth/pypsa-earth

Update API reference of the documentation

Open

#1,379 opened on Mar 13, 2025

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Python (349 forks)auto 404
documentationgood first issue

Repository metrics

Stars
 (351 stars)
PR merge metrics
 (PR metrics pending)

Description

Describe the feature you'd like to see

The API reference of the documentation is missing the sector-coupled scripts. This is an automated section that has to do with each scripts.

Contributor guide

Research direction
Identify the documentation build process and locate where API reference for sector coupled scripts should be added. Look for existing script documentation and replicate the pattern.
Tech stack
python
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80