Add an extra script in `Contributing` to install some of the extra `Doc` requirements i.e. to make it easier to dev & QA
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 18.8k
- Forks
- 2.8k
- Avg merge
- 16h 26m
- Merged PRs (30d)
- 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
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with contributing.md's “Install requirements — non-windows” section and the existing packages/python/plotly/requirements.txt and optional-requirements.txt files. Review the documentation examples under doc/python and identify the extra modules used there, including wget and datashader. Done means an optional-doc-requirements.txt file and updated contributor instructions allow the examples to be tested with jupyter-notebook doc/python.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- jupyter-notebook, python
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100