Sphinx documentation: No backlink to the main project
还没有人认领这个 Issue。
评估
- 难度
- 2/5
- 预计耗时
- 1-3 小时
- 新手友好度
- 68/100
- Issue 类型
- 文档
- 描述清晰度
- 基本清楚
- 活跃度
- 冷清
- 技术栈
- python
调研方向
检查 Python 绑定的 Sphinx 文档配置,尤其是侧边栏设置,并审查生成页面的布局。当文档包含指向 https://precice.org/couple-your-code-api.html 的反向链接,且该链接在侧边栏或等效导航中可见时,工作即完成。
由索引模型根据 Issue 内容生成。
描述
In the Sphinx documentation, there is no backlink to the preCICE website. That would be useful for people landing directly to the Python bindings documentation from a search engine, for example.
I think that adding something in the sidebar, for example, would be good. It could link to https://precice.org/couple-your-code-api.html
Current view:
Diverged from #239
- 主要语言
- Cython
- 星标
- 30
- 派生
- 19
- 平均合并
- 2 天 23 分钟
- 30 天内合并 PR
- 1
环境准备
这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
precice/python-bindings 的其他 Issue
-
enhancement
难度 2/5 1-3 小时 新手友好度 78/100
precice/python-bindings#175 · 2 条评论 ·
-
难度 5/5 一周以上 新手友好度 20/100
precice/python-bindings#255 ·
-
Test package uploading to PyPI before releasing and creating a new version tag可能已有人在做 @Gitjay11 于 203 天前认领。 未关闭good first issue
难度 3/5 1-2 天 新手友好度 68/100
precice/python-bindings#248 ·
-
难度 3/5 1-2 天 新手友好度 38/100
precice/python-bindings#238 · 6 条评论 ·
-
难度 2/5 1-3 小时 新手友好度 45/100
precice/python-bindings#209 ·
查看 precice/python-bindings 的全部 Issue
相似的 Issue
-
enhancement
难度 2/5 1-3 小时 新手友好度 72/100
wimpysworld/sidra#287 ·
维护者通常 1 天内回复
-
难度 1/5 1 小时以内 新手友好度 68/100
-
难度 1/5 1 小时以内 新手友好度 78/100
YSGStudyHards/Awesome-Tools#126 ·
维护者通常 2 天内回复
-
难度 2/5 1-3 小时 新手友好度 68/100
-
source:reader type:enhancement
难度 1/5 1 小时以内 新手友好度 85/100
stephrobert/blog-roadmap#47 ·