Update documentation

ApeWorX · Sep 19, 2024 · b2aeffa · b2aeffa
1 parent feef3c9
commit b2aeffa
Show file tree

Hide file tree

Showing 28 changed files with 131 additions and 82 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_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/config.doctree b/latest/.doctrees/userguides/config.doctree
diff --git a/latest/_sources/userguides/config.md.txt b/latest/_sources/userguides/config.md.txt
@@ -29,6 +29,27 @@ plugin:
 
 This helps keep your secrets out of Ape!
 
+## Base Path
+
+Change the base path if it is different than your project root.
+For example, imagine a project structure like:
+
+```
+project
+└── src/
+    └── contracts/
+        └── MyContract.sol
+```
+
+In this case, you want to configure Ape like:
+
+```yaml
+base_path: src
+```
+
+This way, `MyContract.vy`'s source ID will be `"contracts/Factory.vy"` and not `"src/contracts/Factory.vy"`.
+Some dependencies, such as python-based ones like `snekmate`, use this structure.
+
 ## Contracts Folder
 
 Specify a different path to your `contracts/` directory.

diff --git a/latest/commands/networks.html b/latest/commands/networks.html
@@ -200,7 +200,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 | local | holesky-fork | mainnet-fork | holesky | sepolia-fork | sepolia</p>
+<dd class="field-odd"><p>local | holesky-fork | sepolia | holesky | sepolia-fork | mainnet | mainnet-fork</p>
 </dd>
 </dl>
 </dd></dl>
@@ -211,7 +211,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</p>
 </dd>
 </dl>
 </dd></dl>
@@ -237,7 +237,7 @@ <h2>run<a class="headerlink" href="#networks-run" title="Link to this heading">
 <dd><p>Override the default network and provider. (see <cite>ape networks list</cite> for options)</p>
 <dl class="field-list simple">
 <dt class="field-odd">Options<span class="colon">:</span></dt>
-<dd class="field-odd"><p>:mainnet:node | ethereum:mainnet:node | :mainnet | ethereum:mainnet | :sepolia:node | ethereum:sepolia:node | :sepolia | ethereum:sepolia | :holesky:node | ethereum:holesky:node | :holesky | ethereum:holesky | ::node | :local:node | ethereum::node | ethereum:local:node | ::test | :local:test | ethereum::test | ethereum:local:test | :local | ethereum:local | ethereum</p>
+<dd class="field-odd"><p>:mainnet:node | ethereum:mainnet:node | :mainnet | ethereum:mainnet | :sepolia:node | ethereum:sepolia:node | :sepolia | ethereum:sepolia | :holesky:node | ethereum:holesky:node | :holesky | ethereum:holesky | ::node | :local:node | ethereum::node | ethereum:local:node | :local | ethereum:local | ethereum</p>
 </dd>
 </dl>
 </dd></dl>

diff --git a/latest/genindex.html b/latest/genindex.html
@@ -1780,6 +1780,8 @@ <h2 id="B">B</h2>
         <li><a href="methoddocs/ape_ethereum.html#ape_ethereum.NetworkConfig.base_fee_multiplier">(ape_ethereum.NetworkConfig attribute)</a>
 </li>
       </ul></li>
+      <li><a href="methoddocs/api.html#ape.api.config.ApeConfig.base_path">base_path (ape.api.config.ApeConfig attribute)</a>
+</li>
       <li><a href="methoddocs/api.html#ape.api.address.BaseAddress">BaseAddress (class in ape.api.address)</a>
 </li>
       <li><a href="methoddocs/types.html#ape.types.BaseContractLog">BaseContractLog (class in ape.types)</a>
@@ -1797,11 +1799,11 @@ <h2 id="B">B</h2>
       <li><a href="methoddocs/ape_ethereum.html#ape_ethereum.SharedBlobReceipt.blob_gas_used">blob_gas_used (ape_ethereum.SharedBlobReceipt attribute)</a>
 </li>
       <li><a href="methoddocs/api.html#ape.api.query.ContractCreation.block">block (ape.api.query.ContractCreation attribute)</a>
-</li>
-      <li><a href="methoddocs/ape_ethereum.html#ape_ethereum.Block">Block (class in ape_ethereum)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="methoddocs/ape_ethereum.html#ape_ethereum.Block">Block (class in ape_ethereum)</a>
+</li>
       <li><a href="methoddocs/types.html#ape.types.ContractLog.block_hash">block_hash (ape.types.ContractLog attribute)</a>
 </li>
       <li><a href="methoddocs/types.html#ape.types.ContractLog.block_number">block_number (ape.types.ContractLog attribute)</a>

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/objects.inv b/latest/objects.inv
diff --git a/latest/searchindex.js b/latest/searchindex.js
diff --git a/latest/userguides/config.html b/latest/userguides/config.html
@@ -123,6 +123,7 @@
       <i class="i-lucide close"></i>
     </button>
     <div class="sy-scrollbar sy-rside-inner px-6 xl:top-16 xl:sticky xl:pl-0 pt-6 pb-4"><div class="localtoc"><h3>On this page</h3><ul>
+<li><a class="reference internal" href="#base-path">Base Path</a></li>
 <li><a class="reference internal" href="#contracts-folder">Contracts Folder</a></li>
 <li><a class="reference internal" href="#default-ecosystem">Default Ecosystem</a></li>
 <li><a class="reference internal" href="#dependencies">Dependencies</a></li>
@@ -186,6 +187,23 @@ <h1>Configure Ape<a class="headerlink" href="#configure-ape" title="Link to this
 </span></pre></div>
 </div>
 <p>This helps keep your secrets out of Ape!</p>
+<section id="base-path">
+<h2>Base Path<a class="headerlink" href="#base-path" title="Link to this heading"></a></h2>
+<p>Change the base path if it is different than your project root.
+For example, imagine a project structure like:</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span data-line="1">project
+</span><span data-line="2">└── src/
+</span><span data-line="3">    └── contracts/
+</span><span data-line="4">        └── MyContract.sol
+</span></pre></div>
+</div>
+<p>In this case, you want to configure Ape like:</p>
+<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span data-line="1"><span class="nt">base_path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">src</span>
+</span></pre></div>
+</div>
+<p>This way, <code class="docutils literal notranslate"><span class="pre">MyContract.vy</span></code>’s source ID will be <code class="docutils literal notranslate"><span class="pre">&quot;contracts/Factory.vy&quot;</span></code> and not <code class="docutils literal notranslate"><span class="pre">&quot;src/contracts/Factory.vy&quot;</span></code>.
+Some dependencies, such as python-based ones like <code class="docutils literal notranslate"><span class="pre">snekmate</span></code>, use this structure.</p>
+</section>
 <section id="contracts-folder">
 <h2>Contracts Folder<a class="headerlink" href="#contracts-folder" title="Link to this heading"></a></h2>
 <p>Specify a different path to your <code class="docutils literal notranslate"><span class="pre">contracts/</span></code> directory.