Docs build 2024-06-08

Author: github-actions

en/next/_sources/api/operations.md.txt

@@ -40,7 +40,7 @@ yield StringCommand("echo", "Shell!", _sudo=True)
 Operations can also call other operations using ``yield from`` syntax:
 
 ```py
-yield from files.file(
+yield from files.file._inner(
     path="/some/file",
     ...,
 )

en/next/_sources/contributing.md.txt

@@ -13,7 +13,7 @@ Third party pull requests help expand pyinfra's functionality and are essential
 
 ## Branches
 
-+ There is a branch per major version, ie `2.x`, that tracks the latest release of that version
++ There is a branch per major version, ie `3.x`, that tracks the latest release of that version
 + Changes should generally be based off the latest major branch, unless fixing an old version
 
 ## Dev Setup
@@ -30,15 +30,27 @@ cd pyinfra
 pip install -e '.[dev]'
 ```
 
-## Tests
+### Code Style & Type Checking
 
-GitHub will run all the test suites as part of any pull requests, here's how you can run them locally:
+Code style is enforced via Black, isort and flake8. Types are checked with mypy currently, and pyright is recommended for local development though currently optional. There is a script to run the linting & type-checking:
 
-### Unit Tests
+```sh
+scripts/dev-lint.sh
+```
+
+### Tests
+
+GitHub will run all the test suites as part of any pull requests. There's a handy script that runs the unit tests:
+
+```sh
+scripts/dev-test.sh
+```
+
+#### Unit Tests
 
 Use `pytest` to run the unit tests, or `pytest --cov` to run with coverage. Pull requests are expected to be tested and not drop overall project coverage by >1%.
 
-### End to End Tests
+#### End to End Tests
 
 The end to end tests are also executed via `pytest` but not selected by default, options/usage:
 
@@ -64,7 +76,3 @@ To view ([localhost:8000](http://localhost:8000)):
 ```sh
 python -m http.server -d docs/build/
 ```
-
-## Code Style
-
-Code is linted using `flake8` and uses the `black` / `isort` codestyles. To check you can just run `flake8` from the root directory.

en/next/_sources/getting-started.rst.txt

@@ -5,7 +5,7 @@ This guide should help describe the basics of deploying stuff with pyinfra. Star
 
 .. code:: bash
 
-    pip install pyinfra
+    pip install pyinfra --pre
 
 To do something with pyinfra you need two things:
 

en/next/api/operations.html

@@ -183,7 +183,7 @@ <h3>Output: commands<a class="headerlink" href="#output-commands" title="Permali
 </pre></div>
 </div>
 <p>Operations can also call other operations using <code class="docutils literal notranslate"><span class="pre">yield</span> <span class="pre">from</span></code> syntax:</p>
-<div class="highlight-py notranslate"><div class="highlight"><pre><span></span><span class="k">yield from</span> <span class="n">files</span><span class="o">.</span><span class="n">file</span><span class="p">(</span>
+<div class="highlight-py notranslate"><div class="highlight"><pre><span></span><span class="k">yield from</span> <span class="n">files</span><span class="o">.</span><span class="n">file</span><span class="o">.</span><span class="n">_inner</span><span class="p">(</span>
     <span class="n">path</span><span class="o">=</span><span class="s2">&quot;/some/file&quot;</span><span class="p">,</span>
     <span class="o">...</span><span class="p">,</span>
 <span class="p">)</span>

en/next/contributing.html

@@ -114,14 +114,12 @@ <h3>Navigation</h3>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Contributing</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="#guides">Guides</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#branches">Branches</a></li>
-<li class="toctree-l2"><a class="reference internal" href="#dev-setup">Dev Setup</a></li>
-<li class="toctree-l2"><a class="reference internal" href="#tests">Tests</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="#unit-tests">Unit Tests</a></li>
-<li class="toctree-l3"><a class="reference internal" href="#end-to-end-tests">End to End Tests</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#dev-setup">Dev Setup</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#code-style-type-checking">Code Style &amp; Type Checking</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#tests">Tests</a></li>
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="#generate-documentation">Generate Documentation</a></li>
-<li class="toctree-l2"><a class="reference internal" href="#code-style">Code Style</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="compatibility.html">Compatibility</a></li>
@@ -161,7 +159,7 @@ <h2>Guides<a class="headerlink" href="#guides" title="Permalink to this heading"
 <div class="section" id="branches">
 <h2>Branches<a class="headerlink" href="#branches" title="Permalink to this heading">¶</a></h2>
 <ul class="simple">
-<li>There is a branch per major version, ie <code class="docutils literal notranslate"><span class="pre">2.x</span></code>, that tracks the latest release of that version</li>
+<li>There is a branch per major version, ie <code class="docutils literal notranslate"><span class="pre">3.x</span></code>, that tracks the latest release of that version</li>
 <li>Changes should generally be based off the latest major branch, unless fixing an old version</li>
 </ul>
 </div>
@@ -178,16 +176,25 @@ <h2>Dev Setup<a class="headerlink" href="#dev-setup" title="Permalink to this he
 pip<span class="w"> </span>install<span class="w"> </span>-e<span class="w"> </span><span class="s1">&#39;.[dev]&#39;</span>
 </pre></div>
 </div>
+<div class="section" id="code-style-type-checking">
+<h3>Code Style &amp; Type Checking<a class="headerlink" href="#code-style-type-checking" title="Permalink to this heading">¶</a></h3>
+<p>Code style is enforced via Black, isort and flake8. Types are checked with mypy currently, and pyright is recommended for local development though currently optional. There is a script to run the linting &amp; type-checking:</p>
+<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scripts/dev-lint.sh
+</pre></div>
+</div>
 </div>
 <div class="section" id="tests">
-<h2>Tests<a class="headerlink" href="#tests" title="Permalink to this heading">¶</a></h2>
-<p>GitHub will run all the test suites as part of any pull requests, here’s how you can run them locally:</p>
+<h3>Tests<a class="headerlink" href="#tests" title="Permalink to this heading">¶</a></h3>
+<p>GitHub will run all the test suites as part of any pull requests. There’s a handy script that runs the unit tests:</p>
+<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scripts/dev-test.sh
+</pre></div>
+</div>
 <div class="section" id="unit-tests">
-<h3>Unit Tests<a class="headerlink" href="#unit-tests" title="Permalink to this heading">¶</a></h3>
+<h4>Unit Tests<a class="headerlink" href="#unit-tests" title="Permalink to this heading">¶</a></h4>
 <p>Use <code class="docutils literal notranslate"><span class="pre">pytest</span></code> to run the unit tests, or <code class="docutils literal notranslate"><span class="pre">pytest</span> <span class="pre">--cov</span></code> to run with coverage. Pull requests are expected to be tested and not drop overall project coverage by &gt;1%.</p>
 </div>
 <div class="section" id="end-to-end-tests">
-<h3>End to End Tests<a class="headerlink" href="#end-to-end-tests" title="Permalink to this heading">¶</a></h3>
+<h4>End to End Tests<a class="headerlink" href="#end-to-end-tests" title="Permalink to this heading">¶</a></h4>
 <p>The end to end tests are also executed via <code class="docutils literal notranslate"><span class="pre">pytest</span></code> but not selected by default, options/usage:</p>
 <div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># Run local e2e tests (works on Linux / MacOS, no Windows yet)</span>
 pytest<span class="w"> </span>-m<span class="w"> </span>end_to_end_local
@@ -199,6 +206,7 @@ <h3>End to End Tests<a class="headerlink" href="#end-to-end-tests" title="Permal
 </div>
 </div>
 </div>
+</div>
 <div class="section" id="generate-documentation">
 <h2>Generate Documentation<a class="headerlink" href="#generate-documentation" title="Permalink to this heading">¶</a></h2>
 <p>To generate:</p>
@@ -210,10 +218,6 @@ <h2>Generate Documentation<a class="headerlink" href="#generate-documentation" t
 </pre></div>
 </div>
 </div>
-<div class="section" id="code-style">
-<h2>Code Style<a class="headerlink" href="#code-style" title="Permalink to this heading">¶</a></h2>
-<p>Code is linted using <code class="docutils literal notranslate"><span class="pre">flake8</span></code> and uses the <code class="docutils literal notranslate"><span class="pre">black</span></code> / <code class="docutils literal notranslate"><span class="pre">isort</span></code> codestyles. To check you can just run <code class="docutils literal notranslate"><span class="pre">flake8</span></code> from the root directory.</p>
-</div>
 </div>
 
 

en/next/getting-started.html

@@ -141,7 +141,7 @@ <h3>Navigation</h3>
   <div class="section" id="getting-started">
 <h1>Getting Started<a class="headerlink" href="#getting-started" title="Permalink to this heading">¶</a></h1>
 <p>This guide should help describe the basics of deploying stuff with pyinfra. Start by installing pyinfra with <code class="docutils literal notranslate"><span class="pre">pip</span></code> (see <a class="reference internal" href="install.html"><span class="doc">full install instructions</span></a>):</p>
-<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>pyinfra
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>pyinfra<span class="w"> </span>--pre
 </pre></div>
 </div>
 <p>To do something with pyinfra you need two things:</p>