Readthedocs not generating properly
还没有人认领这个 Issue。
评估
- 难度
- 2/5
- 预计耗时
- 1-3 小时
- 新手友好度
- 58/100
- Issue 类型
- 缺陷
- 描述清晰度
- 描述清楚
- 活跃度
- 停滞
- 技术栈
- docker
调研方向
从 docs/examples.rst 第 10 行和 README.rst 第 40 行开始，然后复现 Read the Docs 文档构建，以检查 code-block 警告。检查这两个位置的指令是否符合文档中说明的语法，并在构建完成且没有这些警告时视为工作完成。
由索引模型根据 Issue 内容生成。
描述
Description
Problem with generating docs in readthedocs. Works locally and on github.
The problem seems to be the empty "..code-block::" directive.
/home/docs/checkouts/readthedocs.org/user_builds/eiffellib/checkouts/stable/docs/examples.rst:10: WARNING: Error in "code-block" directive:
1 argument(s) required, 0 supplied.
.. code-block::
# From https://hub.docker.com/_/rabbitmq
docker run -d --hostname my-rabbit --name some-rabbit -p 8080:15672 -p 5672:5672 rabbitmq:3-management
../README.rst:40: WARNING: Error in "code-block" directive:
1 argument(s) required, 0 supplied.
.. code-block::
# From https://hub.docker.com/_/rabbitmq
docker run -d --hostname my-rabbit --name some-rabbit -p 8080:15672 -p 5672:5672 rabbitmq:3-management
looking for now-outdated files... none found
Motivation
Readthedocs documentation should always work.
Exemplification
Benefits
Working documentation
Possible Drawbacks
none
- 主要语言
- Python
- 星标
- 8
- 派生
- 12
- PR 合并指标
- 30 天内没有已合并 PR
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
eiffel-community/eiffel-pythonlib 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 45/100
eiffel-community/eiffel-pythonlib#44 · 1 条评论 ·
-
难度 5/5 一周以上 新手友好度 35/100
eiffel-community/eiffel-pythonlib#31 · 1 条评论 ·
-
on-hold
难度 5/5 一周以上 新手友好度 35/100
-
难度 4/5 3-5 天 新手友好度 35/100
-
难度 2/5 1-3 小时 新手友好度 35/100
eiffel-community/eiffel-pythonlib#28 · 3 条评论 ·
查看 eiffel-community/eiffel-pythonlib 的全部 Issue
相似的 Issue
-
难度 1/5 1-3 小时 新手友好度 88/100
fossasia/visdom-dev#69 ·
维护者通常 3 天内回复
-
难度 2/5 1-3 小时 新手友好度 75/100
维护者通常 1 天内回复
-
bug
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 1 天内回复
-
BUG: PROD: v1.3.0-beta Onboarding Profile Picture Misaligns When Name Validation Error Appears可能已有人在做 @RitikaSen27 今天认领。 未关闭bug good first issue
难度 2/5 1-3 小时 新手友好度 82/100
AOSSIE-Org/PictoPy#1647 · 2 条评论 ·
维护者通常 2 天内回复
-
[oblt-aw][autodoc] Update workflow docs for gh-aw v0.92.5 and detector permission scope可能已有人在做 @github-actions 今天认领。 未关闭
难度 1/5 1-3 小时 新手友好度 88/100
维护者通常 1 天内回复