Update documentation

ApeWorX · Oct 4, 2024 · 140956b · 140956b
1 parent a7ff303
commit 140956b
Show file tree

Hide file tree

Showing 118 changed files with 7,937 additions and 5,186 deletions.
diff --git a/index.html b/index.html
@@ -2,4 +2,4 @@
 <!DOCTYPE html>
 <meta charset="utf-8">
 <title>Redirecting...</title>
-<meta http-equiv="refresh" content="0; URL=./latest/">
+<meta http-equiv="refresh" content="0; URL=./stable/">
diff --git a/latest/.doctrees/environment.pickle b/latest/.doctrees/environment.pickle
diff --git a/stable/.buildinfo b/stable/.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: 4c3f33432ac797768f78b09d55341f2e
+config: b46fa637138fb600b9e344a8377fd2af
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/stable/.doctrees/commands/cluster.doctree b/stable/.doctrees/commands/cluster.doctree
diff --git a/stable/.doctrees/commands/run.doctree b/stable/.doctrees/commands/run.doctree
diff --git a/stable/.doctrees/environment.pickle b/stable/.doctrees/environment.pickle
diff --git a/stable/.doctrees/index.doctree b/stable/.doctrees/index.doctree
diff --git a/stable/.doctrees/methoddocs/application.doctree b/stable/.doctrees/methoddocs/application.doctree
diff --git a/stable/.doctrees/methoddocs/exceptions.doctree b/stable/.doctrees/methoddocs/exceptions.doctree
diff --git a/stable/.doctrees/methoddocs/middlewares.doctree b/stable/.doctrees/methoddocs/middlewares.doctree
diff --git a/stable/.doctrees/methoddocs/runner.doctree b/stable/.doctrees/methoddocs/runner.doctree
diff --git a/stable/.doctrees/methoddocs/subscriptions.doctree b/stable/.doctrees/methoddocs/subscriptions.doctree
diff --git a/stable/.doctrees/methoddocs/utils.doctree b/stable/.doctrees/methoddocs/utils.doctree
diff --git a/stable/.doctrees/userguides/development.doctree b/stable/.doctrees/userguides/development.doctree
diff --git a/stable/.doctrees/userguides/platform.doctree b/stable/.doctrees/userguides/platform.doctree
diff --git a/stable/.doctrees/userguides/quickstart.doctree b/stable/.doctrees/userguides/quickstart.doctree
diff --git a/stable/_sources/index.md.txt b/stable/_sources/index.md.txt
diff --git a/stable/_sources/index.rst.txt b/stable/_sources/index.rst.txt
@@ -0,0 +1 @@
+.. dynamic-toc-tree::
diff --git a/stable/_sources/userguides/development.md.txt b/stable/_sources/userguides/development.md.txt
@@ -120,6 +120,16 @@ def handle_on_shutdown():
 
 *Changed in 0.2.0*: The behavior of the `@app.on_startup()` decorator and handler signature have changed.  It is now executed only once upon application startup and worker events have moved on `@app.on_worker_startup()`.
 
+### Signing Transactions
+
+If configured, your bot with have `app.signer` which is an Ape account that can sign arbitrary transactions you ask it to.
+To learn more about signing transactions with Ape, see the [documentation](https://docs.apeworx.io/ape/stable/userguides/transactions.html).
+
+```{warning}
+While not recommended, you can use keyfile accounts for automated signing.
+See [this guide](https://docs.apeworx.io/ape/stable/userguides/accounts.html#automation) to learn more about how to do that.
+```
+
 ## Running your Application
 
 Once you have programmed your bot, it's really useful to be able to run it locally and validate that it does what you expect it to do.
@@ -141,9 +151,14 @@ else:
     # Log what the transaction *would* have done, had a signer been enabled
 ```
 
-```{note}
+```{warning}
 If you configure your application to use a signer, and that signer signs anything given to it, remember that you can lose substational amounts of funds if you deploy this to a production network.
-Always test your applications throughly before deploying.
+Always test your applications throughly before deploying, and always use a dedicated key for production signing with your application in a remote setting.
+```
+
+```{note}
+It is highly suggested to use a dedicated cloud signer plugin, such as [`ape-aws`](https://github.com/ApeWorX/ape-aws) for signing transactions in a cloud environment.
+Use segregated keys and limit your risk by controlling the amount of funds that key has access to at any given time.
 ```
 
 ### Distributed Execution

diff --git a/stable/_static/basic.css b/stable/_static/basic.css
@@ -4,7 +4,7 @@
  *
  * Sphinx stylesheet -- basic theme.
  *
- * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */
@@ -237,6 +237,10 @@ a.headerlink {
     visibility: hidden;
 }
 
+a:visited {
+    color: #551A8B;
+}
+
 h1:hover > a.headerlink,
 h2:hover > a.headerlink,
 h3:hover > a.headerlink,
@@ -670,6 +674,16 @@ dd {
     margin-left: 30px;
 }
 
+.sig dd {
+    margin-top: 0px;
+    margin-bottom: 0px;
+}
+
+.sig dl {
+    margin-top: 0px;
+    margin-bottom: 0px;
+}
+
 dl > dd:last-child,
 dl > dd:last-child > :last-child {
     margin-bottom: 0;
@@ -738,6 +752,14 @@ abbr, acronym {
     cursor: help;
 }
 
+.translated {
+    background-color: rgba(207, 255, 207, 0.2)
+}
+
+.untranslated {
+    background-color: rgba(255, 207, 207, 0.2)
+}
+
 /* -- code displays --------------------------------------------------------- */
 
 pre {

diff --git a/stable/_static/css/badge_only.css b/stable/_static/css/badge_only.css
diff --git a/stable/_static/css/theme.css b/stable/_static/css/theme.css