plotly / plotly/plotly.py

Add an extra script in `Contributing` to install some of the extra `Doc` requirements i.e. to make it easier to dev & QA

Ouverte
#4,732 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

feature infrastructure P3
Langage dominant
Python
Étoiles
18.8k
Forks
2.8k
Merge moyen
16 h 26 min
PR mergées (30 j)
21

Description

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

Guide de contribution

Ouvrir le guide de contribution

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 la section « Install requirements — non-windows » de contributing.md ainsi que par les fichiers existants packages/python/plotly/requirements.txt et optional-requirements.txt. Examinez les exemples de documentation sous doc/python et identifiez les modules supplémentaires qui y sont utilisés, notamment wget et datashader. Le travail est considéré comme terminé lorsqu’un fichier optional-doc-requirements.txt et des instructions mises à jour pour les contributeurs permettent de tester les exemples avec jupyter-notebook doc/python.

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

Évaluation

Stack technique
jupyter-notebook, python
Domaine
documentation
Type d'issue
Fonctionnalité
Difficulté
2/5
Temps estimé
1-3 heures
Activité
À l'abandon
Clarté
Clairement spécifiée
Accessibilité débutants
55/100

Recevez les nouvelles issues par e-mail

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