Update documentation

ApeWorX · Sep 16, 2024 · da36fc7 · da36fc7
1 parent 1406ca1
commit da36fc7
Show file tree

Hide file tree

Showing 27 changed files with 81 additions and 78 deletions.
diff --git a/latest/.buildinfo b/latest/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 6ce1fd8587a27cc6c15a80615baab9e2
+config: 86961e2a231412955781d10b51e07411
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/latest/.doctrees/commands/networks.doctree b/latest/.doctrees/commands/networks.doctree
diff --git a/latest/.doctrees/environment.pickle b/latest/.doctrees/environment.pickle
diff --git a/latest/.doctrees/methoddocs/ape.doctree b/latest/.doctrees/methoddocs/ape.doctree
diff --git a/latest/.doctrees/methoddocs/ape_accounts.doctree b/latest/.doctrees/methoddocs/ape_accounts.doctree
diff --git a/latest/.doctrees/methoddocs/ape_compile.doctree b/latest/.doctrees/methoddocs/ape_compile.doctree
diff --git a/latest/.doctrees/methoddocs/ape_ethereum.doctree b/latest/.doctrees/methoddocs/ape_ethereum.doctree
diff --git a/latest/.doctrees/methoddocs/ape_node.doctree b/latest/.doctrees/methoddocs/ape_node.doctree
diff --git a/latest/.doctrees/methoddocs/ape_pm.doctree b/latest/.doctrees/methoddocs/ape_pm.doctree
diff --git a/latest/.doctrees/methoddocs/ape_test.doctree b/latest/.doctrees/methoddocs/ape_test.doctree
diff --git a/latest/.doctrees/methoddocs/api.doctree b/latest/.doctrees/methoddocs/api.doctree
diff --git a/latest/.doctrees/methoddocs/cli.doctree b/latest/.doctrees/methoddocs/cli.doctree
diff --git a/latest/.doctrees/methoddocs/contracts.doctree b/latest/.doctrees/methoddocs/contracts.doctree
diff --git a/latest/.doctrees/methoddocs/exceptions.doctree b/latest/.doctrees/methoddocs/exceptions.doctree
diff --git a/latest/.doctrees/methoddocs/managers.doctree b/latest/.doctrees/methoddocs/managers.doctree
diff --git a/latest/.doctrees/methoddocs/plugins.doctree b/latest/.doctrees/methoddocs/plugins.doctree
diff --git a/latest/.doctrees/methoddocs/types.doctree b/latest/.doctrees/methoddocs/types.doctree
diff --git a/latest/.doctrees/methoddocs/utils.doctree b/latest/.doctrees/methoddocs/utils.doctree
diff --git a/latest/.doctrees/userguides/dependencies.doctree b/latest/.doctrees/userguides/dependencies.doctree
diff --git a/latest/_sources/userguides/dependencies.md.txt b/latest/_sources/userguides/dependencies.md.txt
@@ -57,6 +57,8 @@ Often times, the `v` prefix is required when using tags.
 However, if cloning the tag fails, `ape` will retry with a `v` prefix.
 Bypass the original failing attempt by including a `v` in your dependency config.
 
+**By knowing if the release is from the version API or only available via tag, and whether the version is v-prefixed or not, you save Ape some time and complexity when installing dependencies.**
+
 ### Python
 
 You can use dependencies to PyPI by using the `python:` keyed dependency type.

diff --git a/latest/commands/networks.html b/latest/commands/networks.html
@@ -297,7 +297,7 @@ <h2>list<a class="headerlink" href="#networks-list" title="Permalink to this hea
 <dd><p>Filter the results by network</p>
 <dl class="field-list simple">
 <dt class="field-odd">Options<span class="colon">:</span></dt>
-<dd class="field-odd"><p>holesky | mainnet | sepolia | holesky-fork | sepolia-fork | mainnet-fork | local</p>
+<dd class="field-odd"><p>mainnet | sepolia | local | mainnet-fork | holesky-fork | holesky | sepolia-fork</p>
 </dd>
 </dl>
 </dd></dl>
@@ -308,7 +308,7 @@ <h2>list<a class="headerlink" href="#networks-list" title="Permalink to this hea
 <dd><p>Filter the results by provider</p>
 <dl class="field-list simple">
 <dt class="field-odd">Options<span class="colon">:</span></dt>
-<dd class="field-odd"><p>node | test</p>
+<dd class="field-odd"><p>test | node</p>
 </dd>
 </dl>
 </dd></dl>

diff --git a/latest/methoddocs/ape_node.html b/latest/methoddocs/ape_node.html
diff --git a/latest/methoddocs/api.html b/latest/methoddocs/api.html
diff --git a/latest/methoddocs/contracts.html b/latest/methoddocs/contracts.html
diff --git a/latest/methoddocs/managers.html b/latest/methoddocs/managers.html
diff --git a/latest/searchindex.js b/latest/searchindex.js
diff --git a/latest/userguides/dependencies.html b/latest/userguides/dependencies.html
@@ -322,6 +322,7 @@ <h3>GitHub<a class="headerlink" href="#github" title="Permalink to this heading"
 Often times, the <code class="docutils literal notranslate"><span class="pre">v</span></code> prefix is required when using tags.
 However, if cloning the tag fails, <code class="docutils literal notranslate"><span class="pre">ape</span></code> will retry with a <code class="docutils literal notranslate"><span class="pre">v</span></code> prefix.
 Bypass the original failing attempt by including a <code class="docutils literal notranslate"><span class="pre">v</span></code> in your dependency config.</p>
+<p><strong>By knowing if the release is from the version API or only available via tag, and whether the version is v-prefixed or not, you save Ape some time and complexity when installing dependencies.</strong></p>
 </section>
 <section id="python">
 <h3>Python<a class="headerlink" href="#python" title="Permalink to this heading"></a></h3>