Update documentation

ApeWorX · Jun 17, 2024 · a674a34 · a674a34
1 parent f332f8c
commit a674a34
Show file tree

Hide file tree

Showing 25 changed files with 23 additions and 6 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: 043b756c1ebb2e7f06887969aefee1b5
+config: 9fec82138593cf5a3bf49023dbffc521
 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/config.doctree b/latest/.doctrees/userguides/config.doctree
diff --git a/latest/_sources/userguides/config.md.txt b/latest/_sources/userguides/config.md.txt
@@ -19,6 +19,16 @@ However, here is a list of common-use cases requiring the `ape-config.yaml` file
 2. Setting up project dependencies: See the [dependencies](#dependencies) section.
 3. Declaring your project's plugins: See the [plugins](#plugins) section.
 
+**Environment Variables**: `ape-config.yaml` files support environment-variable expansion.
+Simply include environment variables (with the `$` prefix) in your config file and Ape will automatically expand them.
+
+```yaml
+plugin:
+  secret_rpc: $MY_SECRET_RPC
+```
+
+This helps keep your secrets out of Ape!
+
 ## Contracts Folder
 
 Specify a different path to your `contracts/` directory.

diff --git a/latest/commands/networks.html b/latest/commands/networks.html
@@ -286,7 +286,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>mainnet-fork | sepolia | sepolia-fork | local | holesky | mainnet | holesky-fork</p>
+<dd class="field-odd"><p>sepolia-fork | sepolia | local | holesky | mainnet | mainnet-fork | holesky-fork</p>
 </dd>
 </dl>
 </dd></dl>

diff --git a/latest/methoddocs/ape_node.html b/latest/methoddocs/ape_node.html
diff --git a/latest/methoddocs/utils.html b/latest/methoddocs/utils.html
@@ -974,7 +974,7 @@
 <dd class="field-even"><p>Configured settings parsed from a config file.</p>
 </dd>
 <dt class="field-odd">Return type<span class="colon">:</span></dt>
-<dd class="field-odd"><p>Dict (dict)</p>
+<dd class="field-odd"><p>dict</p>
 </dd>
 </dl>
 </dd></dl>

diff --git a/latest/searchindex.js b/latest/searchindex.js
diff --git a/latest/userguides/config.html b/latest/userguides/config.html
@@ -264,6 +264,13 @@ <h1>Configure Ape<a class="headerlink" href="#configure-ape" title="Permalink to
 <li><p>Setting up project dependencies: See the <a class="reference external" href="#dependencies">dependencies</a> section.</p></li>
 <li><p>Declaring your project’s plugins: See the <a class="reference external" href="#plugins">plugins</a> section.</p></li>
 </ol>
+<p><strong>Environment Variables</strong>: <code class="docutils literal notranslate"><span class="pre">ape-config.yaml</span></code> files support environment-variable expansion.
+Simply include environment variables (with the <code class="docutils literal notranslate"><span class="pre">$</span></code> prefix) in your config file and Ape will automatically expand them.</p>
+<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">plugin</span><span class="p">:</span>
+<span class="w">  </span><span class="nt">secret_rpc</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">$MY_SECRET_RPC</span>
+</pre></div>
+</div>
+<p>This helps keep your secrets out of Ape!</p>
 <section id="contracts-folder">
 <h2>Contracts Folder<a class="headerlink" href="#contracts-folder" title="Permalink to this heading"></a></h2>
 <p>Specify a different path to your <code class="docutils literal notranslate"><span class="pre">contracts/</span></code> directory.