pwr-Solaar/Solaar

Docs: Build developer docs from code

Open

#2,503 opened on May 27, 2024

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Python (383 forks)batch import
enhancementhelp wanted

Repository metrics

Stars
 (4,528 stars)
PR merge metrics
 (PR metrics pending)

Description

Some code pieces already contain docstrings, which should be automatically compiled to documentation and published with GitHub pages on a page Developer documentation.

The numpydoc format is the preferred style.

Contributor guide

Research direction
Set up automatic documentation generation from docstrings using numpydoc format and publish to GitHub Pages.
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.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75