bazel-contrib / bazel-contrib/rules_python

sphinxdocs: output github actions workflow command compatible output

未关闭
#2,893 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
sphinxdocs
主要语言
Starlark
星标
688
派生
721
平均合并
15 小时 7 分钟
30 天内合并 PR
76

描述

GitHub actions support specially formatted output that can then show up in the ui: https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#setting-a-warning-message

So the idea would be: have a bazel flag and/or sphinx plugin that transforms warning/error messages that occur during docs building into that format. They can then show up in the code review UI.

贡献指南

打开贡献指南

调研方向

首先查看 issue 中链接的 GitHub Actions 工作流命令格式,以及 Sphinx 文档构建如何暴露警告和错误输出。确定 Bazel 标志还是 Sphinx 插件是合适的入口点;完成的标准是文档构建消息以 GitHub 能在代码审查界面中显示的格式发出。

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

评估

技术栈
github-actions
领域
ci-cd, documentation
Issue 类型
功能
难度
4/5
预计耗时
3-5 天
活跃度
停滞
描述清晰度
需要澄清
新手友好度
35/100

把新 issue 发到你的邮箱

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