microsoft/vasim

TODO: setup documentation generation

Ouverte

#5 ouverte le 30 août 2024

Voir sur GitHubGuide contributeur
 (1 commentaire) (0 réaction) (0 personne assignée)Python (7 forks)auto 404
TODOdocumentationhelp wanted

Métriques du dépôt

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

Description

As we slowly add the documentation, we also should setup auto doc generation. The pipeline code is in place. This particular setup uses sphinx but there are many options we could chose from.

Guide contributeur

Direction de recherche
Configurez la generation de documentation avec Sphinx : creez le repertoire 'docs', ajoutez conf.py, index.rst et configurez le deploiement sur GitHub Pages ou Read the Docs.
Stack technique
python
Domaine
developer experience
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.
Récente
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.
80