lundybernard/batconf

Cleanup Sphinx documentation

Ouverte

#32 ouverte le 27 juil. 2024

Voir sur GitHub
 (1 commentaire) (0 réaction) (0 personne assignée)Python (3 forks)auto 404
good first issue

Métriques du dépôt

Stars
 (5 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

Description

The documentation needs to be reviewed and cleaned up. Feel free to take on smaller tasks and open new Issues to track them.

Some things that need improvement:

  • Auto-generated API documentation
  • Add a detailed User Guide
  • Enable make docs from the project's root directory, so we don't need to cd into docs/

Guide contributeur

Direction de recherche
Passez en revue la documentation Sphinx existante, identifiez les lacunes dans la documentation API générée automatiquement et dans le guide d'utilisation, et mettez en œuvre les améliorations suggérées.
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.
1-3 heures
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
Aucun
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75