bazel-contrib / bazel-contrib/rules_python

sphinxdocs: output github actions workflow command compatible output

Aperta
#2,893 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
sphinxdocs
Lingua principale
Starlark
Stelle
688
Fork
721
Merge medio
15h 7m
PR unite (30g)
76

Descrizione

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.

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
github-actions
Ambito
ci-cd, documentation
Tipo di issue
Funzionalità
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.