Image duplication for sphinx docs required

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

还没有人认领这个 Issue。

评估

难度
3/5
预计耗时
1-2 天
新手友好度
35/100
Issue 类型
文档
描述清晰度
基本清楚
活跃度
停滞

调研方向

首先比较 README.md 中的图像路径与 docs/ 下的文件,然后从 docs 文件夹运行 make html,以重现缺失的图像。检查 Sphinx 文档设置,并选择一种能够避免图像重复副本的路径安排或搜索配置;完成的标准是 GitHub README 和本地生成或在线的文档都能正确显示图像。

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

描述

bug documentation

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 模板
  • 没有贡献指南

从这里开始

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

aidotse/PASEOS 的其他 Issue

查看 aidotse/PASEOS 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

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