Skip to content

Auto generation of examples #18198

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

Open
wants to merge 6 commits into
base: docs-refactor
Choose a base branch
from
Open

Auto generation of examples #18198

wants to merge 6 commits into from

Conversation

cicdw
Copy link
Member

@cicdw cicdw commented May 28, 2025

This PR organizes things to make it possible to auto generate example documentation from https://github.com/PrefectHQ/examples/tree/examples-markdown

Screenshot of local build:
image

Copy link
Collaborator

@zzstoatzz zzstoatzz left a comment

Choose a reason for hiding this comment

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

curious about when the script happens but lgtm!

text = f.read()

pattern = r"title:\s*(.+)\ndescription:\s*(.+)"
match = re.search(pattern, text)
Copy link
Collaborator

Choose a reason for hiding this comment

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

not important but match is a soft keyword in 3.10+ so i don't like to use it as a variable name

Copy link
Member Author

Choose a reason for hiding this comment

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

ah good call, will update

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants