Add an extra script in `Contributing` to install some of the extra `Doc` requirements i.e. to make it easier to dev & QA
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 18.8k
- Forks
- 2.8k
- Ø Merge
- 16 Std. 26 Min.
- Gemergte PRs (30 T.)
- 21
Beschreibung
Using these commands from Contributing
(plotly_dev) $ pip install -r packages/python/plotly/requirements.txt
(plotly_dev) $ pip install -r packages/python/plotly/optional-requirements.txt
won't install modules e.g. wget, datashader, etc. that are used in docs.
I suggest we add optional-doc-requirements.txt to help install some of these modules so that we could more efficiently test the examples using:
jupyter-notebook doc/python
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
Beginne mit dem Abschnitt „Install requirements — non-windows“ in contributing.md sowie den vorhandenen Dateien packages/python/plotly/requirements.txt und optional-requirements.txt. Überprüfe die Dokumentationsbeispiele unter doc/python und ermittle die dort verwendeten zusätzlichen Module, einschließlich wget und datashader. Als erledigt gilt die Aufgabe, wenn eine Datei optional-doc-requirements.txt und aktualisierte Anweisungen für Mitwirkende es ermöglichen, die Beispiele mit jupyter-notebook doc/python zu testen.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- jupyter-notebook, python
- Bereich
- documentation
- Issue-Typ
- Feature
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Aktivitätsstatus
- Veraltet
- Klarheit
- Klar beschrieben
- Anfängerfreundlichkeit
- 55/100