matrix-org / matrix-org/matrix-python-sdk
Don't pin documentation dependency versions
Ouverte
Personne n'a encore pris cette issue.
documentation
good first issue
- Langage dominant
- Python
- Étoiles
- 266
- Forks
- 118
- Métriques de merge des PR
- Aucune PR mergée en 30 j
Description
Unless really necessary, we shouldn't be pinning any versions of our dependencies. This should be as simple as removing the version pins in setup.py for the Sphinx stuff and making sure the documentation generated is still sane.
Guide de contribution
Ouvrir 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.
Piste de recherche
Examinez setup.py pour connaître les contraintes de version de la dépendance Sphinx et vérifiez comment la documentation est générée. Supprimez les contraintes sauf si elles sont nécessaires, puis générez la documentation et vérifiez que la sortie reste cohérente.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- python
- Domaine
- documentation
- Type d'issue
- Refactorisation
- Difficulté
- 2/5
- Temps estimé
- 1-3 heures
- Activité
- À l'abandon
- Clarté
- Clairement spécifiée
- Accessibilité débutants
- 45/100