Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add stdout/stderr and index support to recipe directive #2495

Merged
merged 13 commits into from
Feb 14, 2025

Conversation

lidavidm
Copy link
Member

@lidavidm lidavidm commented Jan 30, 2025

  • Allow marking up stderr/stdout to be rendered in recipes
    • Syntax follows Go's (// Output:)
  • Allow adding keywords in recipes that will get added into the Sphinx index
  • Add script that parses stderr/stdout and places them in files next to recipes for test harnesses to use
  • Enforce up-to-date output in CI
  • Update Python test harness to validate stdout
  • Update C++ test harness to validate stdout

Fixes #2082.

@lidavidm

This comment was marked as resolved.

@lidavidm lidavidm marked this pull request as ready for review February 7, 2025 05:59
@github-actions github-actions bot modified the milestone: ADBC Libraries 17 Feb 7, 2025
Copy link
Member

@kou kou left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

@lidavidm lidavidm merged commit 2daf226 into apache:main Feb 14, 2025
63 checks passed
@lidavidm lidavidm deleted the docs-stdout branch February 14, 2025 07:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: improve cookbook Sphinx tag
2 participants