guyzmo/git-repo

Write more thorough documentation

Open

#146 ouverte le 21 mars 2017

Voir sur GitHub
 (1 commentaire) (0 réactions) (0 assignés)Python (86 forks)batch import
enhancementgood first issuehelp wanted

Métriques du dépôt

Stars
 (837 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

Description

  • make a full sphinx documentation for the project with
    • proper manual on how to use it (and why not generate a manpage?)
    • documentation of internals
    • upload of all of it on readthedocs

Guide contributeur

Direction de recherche
Configurez la structure de documentation Sphinx dans le projet, créez un manuel d'utilisation approprié et une page man, documentez les détails internes et configurez l'intégration Read the Docs. Référez vous à la structure et au contenu de la documentation de projets Python similaires.
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.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
3-5 jours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Ancienne
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
PythonSphinx
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70