pydoc/2.68.0/apache_beam.yaml.generate_yaml_docs.html - beam-site - Git at Google



 <!DOCTYPE html>
 <html class="writer-html5" lang="en" data-content_root="./">
 <head>
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
   <title>apache_beam.yaml.generate_yaml_docs module &mdash; Apache Beam 2.68.0 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />


       <script src="_static/jquery.js?v=5d32c60e"></script>
       <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
       <script src="_static/documentation_options.js?v=2388e03a"></script>
       <script src="_static/doctools.js?v=9a2dae69"></script>
       <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="apache_beam.yaml.json_utils module" href="apache_beam.yaml.json_utils.html" />
     <link rel="prev" title="apache_beam.yaml.conftest module" href="apache_beam.yaml.conftest.html" />
 </head>

 <body class="wy-body-for-nav">
   <div class="wy-grid-for-nav">
     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
       <div class="wy-side-scroll">
         <div class="wy-side-nav-search" >


           <a href="index.html" class="icon icon-home">
             Apache Beam
           </a>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
     <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
     <input type="hidden" name="check_keywords" value="yes" />
     <input type="hidden" name="area" value="default" />
   </form>
 </div>
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
               <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.coders.html">apache_beam.coders package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.dataframe.html">apache_beam.dataframe package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.io.html">apache_beam.io package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.metrics.html">apache_beam.metrics package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.ml.html">apache_beam.ml package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.options.html">apache_beam.options package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.portability.html">apache_beam.portability package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.runners.html">apache_beam.runners package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.testing.html">apache_beam.testing package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.transforms.html">apache_beam.transforms package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.typehints.html">apache_beam.typehints package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.utils.html">apache_beam.utils package</a></li>
 <li class="toctree-l1 current"><a class="reference internal" href="apache_beam.yaml.html">apache_beam.yaml package</a><ul class="current">
 <li class="toctree-l2"><a class="reference internal" href="apache_beam.yaml.html#subpackages">Subpackages</a></li>
 <li class="toctree-l2 current"><a class="reference internal" href="apache_beam.yaml.html#submodules">Submodules</a><ul class="current">
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.yaml.cache_provider_artifacts.html">apache_beam.yaml.cache_provider_artifacts module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.yaml.conftest.html">apache_beam.yaml.conftest module</a></li>
 <li class="toctree-l3 current"><a class="current reference internal" href="#">apache_beam.yaml.generate_yaml_docs module</a><ul>
 <li class="toctree-l4"><a class="reference internal" href="#apache_beam.yaml.generate_yaml_docs.pretty_example"><code class="docutils literal notranslate"><span class="pre">pretty_example()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#apache_beam.yaml.generate_yaml_docs.config_docs"><code class="docutils literal notranslate"><span class="pre">config_docs()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#apache_beam.yaml.generate_yaml_docs.indent"><code class="docutils literal notranslate"><span class="pre">indent()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#apache_beam.yaml.generate_yaml_docs.longest"><code class="docutils literal notranslate"><span class="pre">longest()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#apache_beam.yaml.generate_yaml_docs.io_grouping_key"><code class="docutils literal notranslate"><span class="pre">io_grouping_key()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#apache_beam.yaml.generate_yaml_docs.add_transform_links"><code class="docutils literal notranslate"><span class="pre">add_transform_links()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#apache_beam.yaml.generate_yaml_docs.transform_docs"><code class="docutils literal notranslate"><span class="pre">transform_docs()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#apache_beam.yaml.generate_yaml_docs.create_index"><code class="docutils literal notranslate"><span class="pre">create_index()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#apache_beam.yaml.generate_yaml_docs.create_examples_markdown"><code class="docutils literal notranslate"><span class="pre">create_examples_markdown()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#apache_beam.yaml.generate_yaml_docs.markdown_to_html"><code class="docutils literal notranslate"><span class="pre">markdown_to_html()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#apache_beam.yaml.generate_yaml_docs.main"><code class="docutils literal notranslate"><span class="pre">main()</span></code></a></li>
 </ul>
 </li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.yaml.json_utils.html">apache_beam.yaml.json_utils module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.yaml.main.html">apache_beam.yaml.main module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.yaml.options.html">apache_beam.yaml.options module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.yaml.yaml_combine.html">apache_beam.yaml.yaml_combine module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.yaml.yaml_enrichment.html">apache_beam.yaml.yaml_enrichment module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.yaml.yaml_errors.html">apache_beam.yaml.yaml_errors module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.yaml.yaml_io.html">apache_beam.yaml.yaml_io module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.yaml.yaml_join.html">apache_beam.yaml.yaml_join module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.yaml.yaml_mapping.html">apache_beam.yaml.yaml_mapping module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.yaml.yaml_ml.html">apache_beam.yaml.yaml_ml module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.yaml.yaml_provider.html">apache_beam.yaml.yaml_provider module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.yaml.yaml_specifiable.html">apache_beam.yaml.yaml_specifiable module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.yaml.yaml_testing.html">apache_beam.yaml.yaml_testing module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.yaml.yaml_transform.html">apache_beam.yaml.yaml_transform module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.yaml.yaml_utils.html">apache_beam.yaml.yaml_utils module</a></li>
 </ul>
 </li>
 </ul>
 </li>
 </ul>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.error.html">apache_beam.error module</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.pipeline.html">apache_beam.pipeline module</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.pvalue.html">apache_beam.pvalue module</a></li>
 </ul>

         </div>
       </div>
     </nav>

     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
           <a href="index.html">Apache Beam</a>
       </nav>

       <div class="wy-nav-content">
         <div class="rst-content">
           <div role="navigation" aria-label="Page navigation">
   <ul class="wy-breadcrumbs">
       <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
           <li class="breadcrumb-item"><a href="apache_beam.yaml.html">apache_beam.yaml package</a></li>
       <li class="breadcrumb-item active">apache_beam.yaml.generate_yaml_docs module</li>
       <li class="wy-breadcrumbs-aside">
             <a href="_sources/apache_beam.yaml.generate_yaml_docs.rst.txt" rel="nofollow"> View page source</a>
       </li>
   </ul>
   <hr/>
 </div>
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">

   <section id="module-apache_beam.yaml.generate_yaml_docs">
 <span id="apache-beam-yaml-generate-yaml-docs-module"></span><h1>apache_beam.yaml.generate_yaml_docs module<a class="headerlink" href="#module-apache_beam.yaml.generate_yaml_docs" title="Link to this heading"></a></h1>
 <dl class="py function">
 <dt class="sig sig-object py" id="apache_beam.yaml.generate_yaml_docs.pretty_example">
 <span class="sig-prename descclassname"><span class="pre">apache_beam.yaml.generate_yaml_docs.</span></span><span class="sig-name descname"><span class="pre">pretty_example</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">provider</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">t</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">base_t</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/generate_yaml_docs.html#pretty_example"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.yaml.generate_yaml_docs.pretty_example" title="Link to this definition"></a></dt>
 <dd></dd></dl>

 <dl class="py function">
 <dt class="sig sig-object py" id="apache_beam.yaml.generate_yaml_docs.config_docs">
 <span class="sig-prename descclassname"><span class="pre">apache_beam.yaml.generate_yaml_docs.</span></span><span class="sig-name descname"><span class="pre">config_docs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">schema</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/generate_yaml_docs.html#config_docs"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.yaml.generate_yaml_docs.config_docs" title="Link to this definition"></a></dt>
 <dd></dd></dl>

 <dl class="py function">
 <dt class="sig sig-object py" id="apache_beam.yaml.generate_yaml_docs.indent">
 <span class="sig-prename descclassname"><span class="pre">apache_beam.yaml.generate_yaml_docs.</span></span><span class="sig-name descname"><span class="pre">indent</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">lines</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">size</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/generate_yaml_docs.html#indent"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.yaml.generate_yaml_docs.indent" title="Link to this definition"></a></dt>
 <dd></dd></dl>

 <dl class="py function">
 <dt class="sig sig-object py" id="apache_beam.yaml.generate_yaml_docs.longest">
 <span class="sig-prename descclassname"><span class="pre">apache_beam.yaml.generate_yaml_docs.</span></span><span class="sig-name descname"><span class="pre">longest</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/generate_yaml_docs.html#longest"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.yaml.generate_yaml_docs.longest" title="Link to this definition"></a></dt>
 <dd></dd></dl>

 <dl class="py function">
 <dt class="sig sig-object py" id="apache_beam.yaml.generate_yaml_docs.io_grouping_key">
 <span class="sig-prename descclassname"><span class="pre">apache_beam.yaml.generate_yaml_docs.</span></span><span class="sig-name descname"><span class="pre">io_grouping_key</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">transform_name</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/generate_yaml_docs.html#io_grouping_key"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.yaml.generate_yaml_docs.io_grouping_key" title="Link to this definition"></a></dt>
 <dd><p>Place reads and writes next to each other, after all other transforms.</p>
 </dd></dl>

 <dl class="py function">
 <dt class="sig sig-object py" id="apache_beam.yaml.generate_yaml_docs.add_transform_links">
 <span class="sig-prename descclassname"><span class="pre">apache_beam.yaml.generate_yaml_docs.</span></span><span class="sig-name descname"><span class="pre">add_transform_links</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">transform</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">provider_list</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/generate_yaml_docs.html#add_transform_links"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.yaml.generate_yaml_docs.add_transform_links" title="Link to this definition"></a></dt>
 <dd><p>Convert references of Providers to urls that link to their respective pages.</p>
 <dl class="simple">
 <dt>For example,</dt><dd><p>“Some description talking about MyTransform.”</p>
 </dd>
 <dt>would be converted to</dt><dd><p>“Some description talking about &lt;a href=”#mytransform”&gt;MyTransform&lt;/a&gt;”</p>
 </dd>
 </dl>
 <p>meanwhile:</p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="nb">type</span><span class="p">:</span> <span class="n">MyTransform</span>
 <span class="n">config</span><span class="p">:</span>
   <span class="o">...</span>
 </pre></div>
 </div>
 <p>Would remain unchanged.</p>
 <p>Avoid self-linking within a Transform page.</p>
 </dd></dl>

 <dl class="py function">
 <dt class="sig sig-object py" id="apache_beam.yaml.generate_yaml_docs.transform_docs">
 <span class="sig-prename descclassname"><span class="pre">apache_beam.yaml.generate_yaml_docs.</span></span><span class="sig-name descname"><span class="pre">transform_docs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">transform_base</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">transforms</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">providers</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">extra_docs</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/generate_yaml_docs.html#transform_docs"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.yaml.generate_yaml_docs.transform_docs" title="Link to this definition"></a></dt>
 <dd></dd></dl>

 <dl class="py function">
 <dt class="sig sig-object py" id="apache_beam.yaml.generate_yaml_docs.create_index">
 <span class="sig-prename descclassname"><span class="pre">apache_beam.yaml.generate_yaml_docs.</span></span><span class="sig-name descname"><span class="pre">create_index</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">include</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">options</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/generate_yaml_docs.html#create_index"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.yaml.generate_yaml_docs.create_index" title="Link to this definition"></a></dt>
 <dd></dd></dl>

 <dl class="py function">
 <dt class="sig sig-object py" id="apache_beam.yaml.generate_yaml_docs.create_examples_markdown">
 <span class="sig-prename descclassname"><span class="pre">apache_beam.yaml.generate_yaml_docs.</span></span><span class="sig-name descname"><span class="pre">create_examples_markdown</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/generate_yaml_docs.html#create_examples_markdown"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.yaml.generate_yaml_docs.create_examples_markdown" title="Link to this definition"></a></dt>
 <dd></dd></dl>

 <dl class="py function">
 <dt class="sig sig-object py" id="apache_beam.yaml.generate_yaml_docs.markdown_to_html">
 <span class="sig-prename descclassname"><span class="pre">apache_beam.yaml.generate_yaml_docs.</span></span><span class="sig-name descname"><span class="pre">markdown_to_html</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">title</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">markdown_content</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">header</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/generate_yaml_docs.html#markdown_to_html"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.yaml.generate_yaml_docs.markdown_to_html" title="Link to this definition"></a></dt>
 <dd></dd></dl>

 <dl class="py function">
 <dt class="sig sig-object py" id="apache_beam.yaml.generate_yaml_docs.main">
 <span class="sig-prename descclassname"><span class="pre">apache_beam.yaml.generate_yaml_docs.</span></span><span class="sig-name descname"><span class="pre">main</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/generate_yaml_docs.html#main"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.yaml.generate_yaml_docs.main" title="Link to this definition"></a></dt>
 <dd></dd></dl>

 </section>


            </div>
           </div>
           <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
         <a href="apache_beam.yaml.conftest.html" class="btn btn-neutral float-left" title="apache_beam.yaml.conftest module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
         <a href="apache_beam.yaml.json_utils.html" class="btn btn-neutral float-right" title="apache_beam.yaml.json_utils module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
     </div>

   <hr/>

   <div role="contentinfo">
     <p>&#169; Copyright %Y, Apache Beam.</p>
   </div>

   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
     <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
     provided by <a href="https://readthedocs.org">Read the Docs</a>.


 </footer>
         </div>
       </div>
     </section>
   </div>
   <script>
       jQuery(function () {
           SphinxRtdTheme.Navigation.enable(true);
       });
   </script>

 </body>
 </html>