Update documentation

ApeWorX · Oct 31, 2024 · d6664a6 · d6664a6
1 parent 515ef97
commit d6664a6
Show file tree

Hide file tree

Showing 19 changed files with 16 additions and 5 deletions.
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_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/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/commands/networks.html b/latest/commands/networks.html
@@ -204,7 +204,7 @@ <h2>list<a class="headerlink" href="#networks-list" title="Link to this heading"
 <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>mainnet-fork | sepolia-fork | holesky | sepolia | local | mainnet | holesky-fork</p>
+<dd class="field-odd"><p>holesky | local | holesky-fork | mainnet | sepolia-fork | sepolia | mainnet-fork</p>
 </dd>
 </dl>
 </dd></dl>
@@ -215,7 +215,7 @@ <h2>list<a class="headerlink" href="#networks-list" title="Link to this heading"
 <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>test | node</p>
+<dd class="field-odd"><p>node | test</p>
 </dd>
 </dl>
 </dd></dl>

diff --git a/latest/genindex.html b/latest/genindex.html
@@ -2809,7 +2809,11 @@ <h2 id="P">P</h2>
       <li><a href="methoddocs/managers.html#ape.managers.networks.NetworkManager.parse_network_choice">parse_network_choice() (ape.managers.networks.NetworkManager method)</a>
 </li>
       <li><a href="methoddocs/api.html#ape.api.projects.ProjectAPI.path">path (ape.api.projects.ProjectAPI attribute)</a>
+
+      <ul>
+        <li><a href="methoddocs/managers.html#ape.managers.project.LocalProject.path">(ape.managers.project.LocalProject property)</a>
 </li>
+      </ul></li>
       <li><a href="methoddocs/cli.html#ape.cli.paramtype.Path">Path (class in ape.cli.paramtype)</a>
 </li>
       <li><a href="methoddocs/utils.html#ape.utils.path_match">path_match() (in module ape.utils)</a>

diff --git a/latest/methoddocs/ape_node.html b/latest/methoddocs/ape_node.html
diff --git a/latest/methoddocs/managers.html b/latest/methoddocs/managers.html
@@ -393,6 +393,7 @@
 <li><a class="reference internal" href="#ape.managers.project.LocalProject.isolate_in_tempdir"><code class="docutils literal notranslate">isolate_in_tempdir()</span></code></a></li>
 <li><a class="reference internal" href="#ape.managers.project.LocalProject.load_manifest"><code class="docutils literal notranslate">load_manifest()</span></code></a></li>
 <li><a class="reference internal" href="#ape.managers.project.LocalProject.meta"><code class="docutils literal notranslate">meta</span></code></a></li>
+<li><a class="reference internal" href="#ape.managers.project.LocalProject.path"><code class="docutils literal notranslate">path</span></code></a></li>
 <li><a class="reference internal" href="#ape.managers.project.LocalProject.project_api"><code class="docutils literal notranslate">project_api</span></code></a></li>
 <li><a class="reference internal" href="#ape.managers.project.LocalProject.refresh_sources"><code class="docutils literal notranslate">refresh_sources()</span></code></a></li>
 <li><a class="reference internal" href="#ape.managers.project.LocalProject.reload_config"><code class="docutils literal notranslate">reload_config()</span></code></a></li>
@@ -3065,6 +3066,12 @@ <h2>Chain<a class="headerlink" href="#chain" title="Link to this heading"></a
 Use when publishing your package manifest.</p>
 </dd></dl>
 
+<dl class="py property">
+<dt class="sig sig-object py" id="ape.managers.project.LocalProject.path">
+<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">path</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Path</span></em><a class="headerlink" href="#ape.managers.project.LocalProject.path" title="Link to this definition"></a></dt>
+<dd><p>The path to the project’s “base” (where contract source IDs are relative to).</p>
+</dd></dl>
+
 <dl class="py property">
 <dt class="sig sig-object py" id="ape.managers.project.LocalProject.project_api">
 <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">project_api</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="api.html#ape.api.projects.ProjectAPI" title="ape.api.projects.ProjectAPI"><span class="pre">ProjectAPI</span></a></em><a class="headerlink" href="#ape.managers.project.LocalProject.project_api" title="Link to this definition"></a></dt>

diff --git a/latest/objects.inv b/latest/objects.inv
diff --git a/latest/searchindex.js b/latest/searchindex.js