Image duplication for sphinx docs required
还没有人认领这个 Issue。
评估
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 新手友好度
- 35/100
- Issue 类型
- 文档
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
调研方向
首先比较 README.md 中的图像路径与 docs/ 下的文件,然后从 docs 文件夹运行 make html,以重现缺失的图像。检查 Sphinx 文档设置,并选择一种能够避免图像重复副本的路径安排或搜索配置;完成的标准是 GitHub README 和本地生成或在线的文档都能正确显示图像。
由索引模型根据 Issue 内容生成。
描述
Issue
Problem Description
Right now, the images in the readme.md have to also be in the docs folder for the paths to be solved correctly when generating the docs with sphinx.
Expected Behavior
One copy of the images should be fine.
What Needs to be Done
Find some way to make sphinx search the repo root not only the docs folder. or alternative find mutually compatible path where to store the images.
How Can It Be Tested or Reproduced
Look at readme on github and docs online or locally via make html in the docs folder.
- 主要语言
- Python
- 星标
- 64
- 派生
- 16
- PR 合并指标
- 30 天内没有已合并 PR
环境准备
- 提供 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 没有贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
aidotse/PASEOS 的其他 Issue
-
bug enhancement good first issue help wanted
难度 2/5 1-3 小时 新手友好度 68/100
-
Sensor Anomalies未关闭enhancement example
难度 5/5 一周以上 新手友好度 25/100
-
难度 5/5 一周以上 新手友好度 25/100
-
enhancement user-facing visualization
难度 4/5 3-5 天 新手友好度 30/100
-
feature
难度 3/5 1-2 天 新手友好度 45/100
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 65/100
Deltares/numba_celltree#100 · 1 条评论 ·
-
auto-reported bug
难度 2/5 1-3 小时 新手友好度 63/100
维护者通常 1 天内回复
-
soup airgap-bundle --bundle-size-cap nan, inf or a cap above ~1.67e299 GiB stops with an internal ValueError/OverflowError (exit 1) instead of a usage error可能已有人在做 @Keshemir 今天认领。 未关闭bug claimed difficulty:2
难度 2/5 1-3 小时 新手友好度 82/100
MakazhanAlpamys/Soup#3045 · 2 条评论 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 76/100
dagster-io/skills#80 ·
-
bug
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 1 天内回复