jesp1999/heckbot

Add documentation generator integration

Ouverte

#57 ouverte le 4 févr. 2023

Voir sur GitHub
 (0 commentaire) (0 réaction) (0 personne assignée)Python (4 forks)auto 404
documentationgood first issuehelp wanted

Métriques du dépôt

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

Description

Either Sphinx, readthedocs, or Mkdocs will work. Slight preference towards readthedocs but I'm open to trying new things.

Sphinx startup: https://www.sphinx-doc.org/en/master/usage/quickstart.html Mkdocs startup: https://www.mkdocs.org/getting-started/ Readthedocs startup: https://docs.readthedocs.io/en/stable/tutorial/

Guide contributeur

Direction de recherche
Choisissez l'un de Sphinx, Mkdocs ou Readthedocs, puis suivez son guide de demarrage pour le configurer pour ce projet Python. Concentrez vous sur la generation de documentation a partir de docstrings ou l'ecriture de nouvelle documentation.
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.
1
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.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90