JuliaDocs/Documenter.jl

Debugging failing links in docstrings from other packages.

Open

#2,053 创建于 2023年2月21日

在 GitHub 查看
 (0 评论) (1 反应) (0 负责人)Julia (513 fork)batch import
Type: Enhancementhelp wanted

仓库指标

Star
 (910 star)
PR 合并指标
 (平均合并 16天 9小时) (30 天内合并 3 个 PR)

描述

If you have documentation that pools docstrings from various packages, it becomes cumbersome to track down where failing links are located.

Could Documenter print the page the error is occurring on? I think it already does this for cross references. Capture https://buildkite.com/julialang/diffeqdocs-dot-jl/builds/14#018673f4-48b0-4668-b3ad-f3d119762be2/1245-1848 (Picture included since link will be inaccessible to most.)

贡献者指南

研究方向
检查 Documenter.jl 中的链接验证模块，找到打印损坏链接错误的位置。将源页面 URL 添加到错误消息中。
技术栈
无
领域
documentation
议题类型
功能
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 小时
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
JuliaDocumenter.jl
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
70