Add an extra script in `Contributing` to install some of the extra `Doc` requirements i.e. to make it easier to dev & QA
未关闭
还没有人认领这个 Issue。
feature
infrastructure
P3
- 主要语言
- Python
- 星标
- 18.8k
- 派生
- 2.8k
- 平均合并
- 16 小时 26 分钟
- 30 天内合并 PR
- 21
描述
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
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
从 contributing.md 的“Install requirements — non-windows”部分以及现有的 packages/python/plotly/requirements.txt 和 optional-requirements.txt 文件开始。检查 doc/python 下的文档示例,并确定其中使用的额外模块,包括 wget 和 datashader。完成标准是:提供 optional-doc-requirements.txt 文件并更新贡献者说明,使这些示例可以通过 jupyter-notebook doc/python 进行测试。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- jupyter-notebook, python
- 领域
- documentation
- Issue 类型
- 功能
- 难度
- 2/5
- 预计耗时
- 1-3 小时
- 活跃度
- 停滞
- 描述清晰度
- 描述清楚
- 新手友好度
- 55/100