[yaml] Enhance YAML API docs
The current YAML API refernce docs look like the following:
This PR adds formatting to make the docs look more like the Sphinx-themed PyDocs used by the Python SDK:
This change not only adds some color and easier-to-read formatting, but also separates the transforms into individual pages to reduce clutter. This should hopefully make the user-experience a bit better.
Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:
- [ ] Mention the appropriate issue in your description (for example:
addresses #123), if applicable. This will automatically add a link to the pull request in the issue. If you would like the issue to automatically close on merging the pull request, commentfixes #<ISSUE NUMBER>instead. - [ ] Update
CHANGES.mdwith noteworthy changes. - [ ] If this contribution is large, please file an Apache Individual Contributor License Agreement.
See the Contributor Guide for more tips on how to make review process smoother.
To check the build health, please visit https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md
GitHub Actions Tests Status (on master branch)
See CI.md for more information about GitHub Actions CI or the workflows README to see a list of phrases to trigger workflows.
R: @robertwb
Stopping reviewer notifications for this pull request: review requested by someone other than the bot, ceding control. If you'd like to restart, comment assign set of reviewers
Codecov Report
Attention: Patch coverage is 0% with 4 lines in your changes missing coverage. Please review.
Project coverage is 60.44%. Comparing base (
67dc973) to head (a8987bd). Report is 7 commits behind head on master.
| Files with missing lines | Patch % | Lines |
|---|---|---|
| sdks/python/apache_beam/yaml/generate_yaml_docs.py | 0.00% | 4 Missing :warning: |
Additional details and impacted files
@@ Coverage Diff @@
## master #32825 +/- ##
============================================
+ Coverage 60.39% 60.44% +0.04%
Complexity 15099 15099
============================================
Files 2735 2736 +1
Lines 265201 265331 +130
Branches 12106 12106
============================================
+ Hits 160171 160378 +207
+ Misses 98610 98533 -77
Partials 6420 6420
| Flag | Coverage Δ | |
|---|---|---|
| python | 81.59% <0.00%> (+0.14%) |
:arrow_up: |
Flags with carried forward coverage won't be shown. Click here to find out more.
:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.
Can you check https://github.com/apache/beam/actions/runs/11579341692/job/32235315129?pr=32825?
Test failures are pretty clearly unrelated, so I'm going to merge