bazel-contrib / bazel-contrib/rules_python

sphinxdocs: output github actions workflow command compatible output

Open
#2,893 0 comments 0 reactions 0 assignees View on GitHub
sphinxdocs
Dominant language
Starlark
Stars
688
Forks
721
Avg merge
15h 7m
Merged PRs (30d)
76

Description

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.

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the GitHub Actions workflow-command format linked in the issue and how the Sphinx documentation build exposes warning and error output. Determine whether a Bazel flag or Sphinx plugin is the appropriate entry point; done means documentation build messages are emitted in a format that GitHub can display in the code review UI.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions
Domain
ci-cd, documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.