labthings / labthings/python-labthings

RTD documentation

Ouverte
#5 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

critical documentation in progress
Langage dominant
Python
Étoiles
19
Forks
2
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

A lot of stuff can be generated using Sphinx autodocs.

A lot of the documentation around writing Things and Extensions can be taken from the OpenFlexure Microscope docs with little change.

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par localiser la configuration de documentation Sphinx du projet ainsi que le code couvert par autodocs. Consultez la documentation d’OpenFlexure Microscope pour trouver des informations sur l’écriture de Things et Extensions, puis identifiez ce qui s’applique ici. Le travail sera considéré comme terminé lorsque la documentation pertinente aura été générée ou adaptée pour python-labthings et se construira correctement.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
python
Domaine
documentation
Type d'issue
Documentation
Difficulté
4/5
Temps estimé
3-5 jours
Activité
À l'abandon
Clarté
À clarifier
Accessibilité débutants
30/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.