pwr-Solaar/Solaar

Docs: Build developer docs from code

Open

#2 503 ouverte le 27 mai 2024

Voir sur GitHub
 (2 commentaires) (0 réactions) (0 assignés)Python (383 forks)batch import
enhancementhelp wanted

Métriques du dépôt

Stars
 (4 528 stars)
Métriques de merge PR
 (Merge moyen 1j 15h) (5 PRs mergées en 30 j)

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.

Guide contributeur

Direction de recherche
Configurez la génération automatique de documentation à partir des docstrings en utilisant le format numpydoc et publiez la sur GitHub Pages.
Stack technique
python
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
PythonGit
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75