Publish documentation using Sphinx
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Accessibilité débutants
- 25/100
- Type d'issue
- Documentation
- Clarté
- À clarifier
- Activité
- À l'abandon
- Stack technique
- python
- Domaine
- documentation
Piste de recherche
L’issue mentionne Sphinx et renvoie vers un guide de documentation Python, mais ne contient aucun fichier du dépôt, test ou point d’entrée de la documentation. Examinez d’abord la structure de documentation existante et le guide indiqué ; le travail est terminé lorsque la documentation du projet est configurée et publiée avec Sphinx.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
While looking at #33 that seemed like the simplest approach / lowest hanging fruit and exciting to publish docs with, the better documentation publishing for Python is Sphinx.
Let's therefore use Sphinx instead following this - http://docs.python-guide.org/en/latest/writing/documentation/
- Langage dominant
- Python
- Étoiles
- 19
- Forks
- 20
- Métriques de merge des PR
- Aucune PR mergée en 30 j
Préparer son environnement
- Fournit un Dockerfile ou un fichier Docker Compose
- Propose un modèle de pull request
- Lire le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de CodeForAfrica/HealthTools.API
-
Is it up?Ouverte
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 20/100
CodeForAfrica/HealthTools.API#138 ·
-
Difficulté 3/5 1-2 jours Accessibilité débutants 35/100
CodeForAfrica/HealthTools.API#136 ·
-
Update test scriptsOuverte
Difficulté 3/5 1-2 jours Accessibilité débutants 35/100
-
Upgrade runtime to Python3Ouverte
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 20/100
-
Difficulté 2/5 1-3 heures Accessibilité débutants 45/100
Toutes les issues de CodeForAfrica/HealthTools.API
Issues similaires
-
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
Juniper/ansible-junos-stdlib#904 ·
-
Difficulté 2/5 1-3 heures Accessibilité débutants 82/100
pollen-robotics/reachy_mini#1457 ·
Les mainteneurs répondent en général sous 1 jour
-
area:runtime good first issue
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
WATonomous/wato_f1tenth#39 ·
-
Difficulté 2/5 1-3 heures Accessibilité débutants 82/100
FireDynamics/fdsreader#123 ·
-
Difficulté 1/5 Moins d'une heure Accessibilité débutants 85/100