matrix-org / matrix-org/matrix-python-sdk
Don't pin documentation dependency versions
Offen
Dieses Issue hat noch niemand übernommen.
documentation
good first issue
- Vorherrschende Sprache
- Python
- Sterne
- 266
- Forks
- 118
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
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.
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Untersuche setup.py auf die Versions-Pins der Sphinx-Abhängigkeit und prüfe, wie die Dokumentation generiert wird. Entferne die Pins, sofern sie nicht notwendig sind, generiere anschließend die Dokumentation und verifiziere, dass die Ausgabe weiterhin plausibel ist.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- documentation
- Issue-Typ
- Refactoring
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Aktivitätsstatus
- Veraltet
- Klarheit
- Klar beschrieben
- Anfängerfreundlichkeit
- 45/100