apache_beam.yaml.generate_yaml_docs module

apache_beam.yaml.generate_yaml_docs.pretty_example(provider, t, base_t=None)

apache_beam.yaml.generate_yaml_docs.config_docs(schema)

apache_beam.yaml.generate_yaml_docs.indent(lines, size)

apache_beam.yaml.generate_yaml_docs.longest(func, xs)

apache_beam.yaml.generate_yaml_docs.io_grouping_key(transform_name)

Place reads and writes next to each other, after all other transforms.

apache_beam.yaml.generate_yaml_docs.add_transform_links(transform, description, provider_list)

Convert references of Providers to urls that link to their respective pages.

For example,

“Some description talking about MyTransform.”

would be converted to

“Some description talking about <a href=”#mytransform”>MyTransform</a>”

meanwhile:

type: MyTransform
config:
  ...

Would remain unchanged.

Avoid self-linking within a Transform page.

apache_beam.yaml.generate_yaml_docs.transform_docs(transform_base, transforms, providers, extra_docs='')

apache_beam.yaml.generate_yaml_docs.main()