matplotlib / matplotlib/sampledoc

Not friendly to Windows users

未关闭
#4 0 条评论 1 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

主要语言
CSS
星标
43
派生
89
PR 合并指标
30 天内没有已合并 PR

描述

I get to the repo to learn how to use Sphinx, but I find it really not that easy for Windows users.
1st, I shall look for the Sphinx scripts & exes(like sphinx-quickstart.exe);
2nd, I shall set the %SPHINXBUILD% env-var(no tip in the material).
And there's no tips for the new comers telling how to setup the Sphinx on Windows, though it's easy to type: 'python.exe setup.py install' under the source folder.

贡献指南

这个仓库没有索引到贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

从源文件夹中的现有 Sphinx 设置材料和 setup.py 开始。说明 Windows 用户在哪里可以找到 Sphinx 脚本和可执行文件、如何设置 %SPHINXBUILD% 环境变量,以及如何使用 python.exe setup.py install 安装 Sphinx。完成的标准是,新手无需猜测就能按照 Windows 设置指南进行操作。

由索引模型根据 Issue 内容生成。

评估

技术栈
python
领域
documentation
Issue 类型
文档
难度
2/5
预计耗时
1-3 小时
活跃度
停滞
描述清晰度
基本清楚
新手友好度
42/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。