`_
diff --git a/docs/source/cli_helpdocs/boardwalk/boardwalk.md b/docs/source/cli_helpdocs/boardwalk/boardwalk.md
new file mode 100644
index 0000000..dc787e5
--- /dev/null
+++ b/docs/source/cli_helpdocs/boardwalk/boardwalk.md
@@ -0,0 +1,33 @@
+# `boardwalk`
+
+
+
+
+
+ Usage: boardwalk [OPTIONS] COMMAND [ARGS]...
+
+ Boardwalk is a linear remote execution workflow engine built on top of Ansible. See the README.md @
+ https://github.com/Backblaze/boardwalk for more info
+ To see more info about any subcommand, do `boardwalk <subcommand> --help`
+
+āā Options āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāā®
+ā --verbose -v INTEGER RANGE [0<=x<=5] Whether or not output messages should be verbose. Additional -v's ā
+ā increases the verbosity ā
+ā [env var: BOARDWALK_VERBOSITY] ā
+ā [default: 0; 0<=x<=5] ā
+ā --help Show this message and exit. ā
+ā°āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāÆ
+āā Commands āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāā®
+ā catch Catch workflow in active workspace ā
+ā check Runs workflow in check mode. Equivalent to run --check ā
+ā init Inits local workspace state by getting host facts ā
+ā login Login to the API ā
+ā release Removes catch from active workspace ā
+ā run Runs workflow jobs ā
+ā version Prints the boardwalk module version number and exits ā
+ā workspace Subcommand group for working with workspaces ā
+ā°āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāÆ
+
+
+
+
+
+
+ Usage: boardwalk catch [OPTIONS]
+
+ Creates 'catch' in the active workspace. Workflows will stop at the next host. Catch remains in place until
+ released
+
+āā Options āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāā®
+ā --help Show this message and exit. ā
+ā°āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāÆ
+
+
+
+
+
+
+ Usage: boardwalk check [OPTIONS]
+
+ Runs workflow in check mode. Equivalent to run --check
+
+āā Options āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāā®
+ā --sort-hosts -s [shuffle|s|ascending|a|descend Overrides the workspace's ā
+ā ing|d|] default sort ordering. May be ā
+ā specified with first letter ā
+ā --server-connect/--no-server-cā¦ -sc/-nsc Whether or not connect to the ā
+ā configured boardwalkd server, ā
+ā if any. It may be dangerous to ā
+ā run workflows without ā
+ā connecting to the server ā
+ā [default: server-connect] ā
+ā --limit -l TEXT An Ansible pattern to limit ā
+ā hosts by. Defaults to no limit ā
+ā --ask-become-pass/--no-ask-becā¦ -K/-nK Whether or not ask for a become ā
+ā password. The ā
+ā ANSIBLE_BECOME_ASK_PASS env var ā
+ā can also set this ā
+ā --help Show this message and exit. ā
+ā°āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāÆ
+
+
+
+
+
+
+ Usage: boardwalk init [OPTIONS]
+
+ Inits the workspace state with host data. Gathers Ansible facts for hosts matching the workspaces host
+ pattern. OK to run multiple times; hosts are only added or updated, never removed by this operation. Use
+ `boardwalk workspace reset` to clear existing state if needed
+
+āā Options āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāā®
+ā --limit -l TEXT An Ansible pattern to limit hosts by. Defaults to no limit ā
+ā --retry/--no-retry -r/-nr Retry getting state for hosts that were unreachable/failed on the last ā
+ā attempt ā
+ā [default: no-retry] ā
+ā --help Show this message and exit. ā
+ā°āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāÆ
+
+
+
+
+
+
+ Usage: boardwalk login [OPTIONS]
+
+ Login to the API
+
+āā Options āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāā®
+ā --help Show this message and exit. ā
+ā°āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāÆ
+
+
+
+
+
+
+ Usage: boardwalk release [OPTIONS]
+
+ Removes catch from active workspace. Any running workflow will resume if it was caught
+
+āā Options āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāā®
+ā --help Show this message and exit. ā
+ā°āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāÆ
+
+
+
+
+
+
+ Usage: boardwalk run [OPTIONS]
+
+ Runs workflow jobs defined in the Boardwalkfile.py
+
+āā Options āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāā®
+ā --ask-become-pass/--no-ask-becā¦ -K/-nK Whether or not ask for a become ā
+ā password. The ā
+ā ANSIBLE_BECOME_ASK_PASS env var ā
+ā can also set this ā
+ā [default: no-ask-become-pass] ā
+ā --check/--no-check -C/-nC Whether or not to run Ansible ā
+ā in --check/-C mode ā
+ā [default: no-check] ā
+ā --limit -l TEXT An Ansible pattern to limit ā
+ā hosts by. Defaults to no limit ā
+ā --server-connect/--no-server-cā¦ -sc/-nsc Whether or not connect to the ā
+ā configured boardwalkd server, ā
+ā if any. It may be dangerous to ā
+ā run workflows without ā
+ā connecting to the server ā
+ā [default: server-connect] ā
+ā --sort-hosts -s [shuffle|s|ascending|a|descend Overrides the workspace's ā
+ā ing|d|] default sort ordering. May be ā
+ā specified with first letter ā
+ā --stomp-locks/--no-stomp-locks Whether or not to ignore and ā
+ā override existing host locks. ā
+ā Probably dangerous ā
+ā [default: no-stomp-locks] ā
+ā --help Show this message and exit. ā
+ā°āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāÆ
+
+
+
+
+
+
+ Usage: boardwalk version [OPTIONS]
+
+ Prints the boardwalk module version number and exits
+
+āā Options āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāā®
+ā --help Show this message and exit. ā
+ā°āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāÆ
+
+
+
+
+
+
+ Usage: boardwalk workspace [OPTIONS] COMMAND [ARGS]...
+
+āā Options āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāā®
+ā --help Show this message and exit. ā
+ā°āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāÆ
+āā Commands āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāā®
+ā dump Prints the active workspace's state to stdout as JSON ā
+ā list Lists available workspaces from the Boardwalkfile.py ā
+ā reset Resets active workspace ā
+ā show Displays the active workspace ā
+ā use Sets the active workspace ā
+ā°āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāÆ
+
+
+
+
+
+
+ Usage: boardwalk workspace dump [OPTIONS]
+
+ Prints the active workspace's state to stdout as JSON
+
+āā Options āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāā®
+ā --help Show this message and exit. ā
+ā°āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāÆ
+
+
+
+
+
+
+ Usage: boardwalk workspace list [OPTIONS]
+
+ Lists available workspaces from the Boardwalkfile.py
+
+āā Options āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāā®
+ā --help Show this message and exit. ā
+ā°āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāÆ
+
+
+
+
+
+
+ Usage: boardwalk workspace reset [OPTIONS]
+
+ Resets/clears the active workspace state
+
+āā Options āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāā®
+ā --yes Confirm the action without prompting. ā
+ā --help Show this message and exit. ā
+ā°āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāÆ
+
+
+
+
+
+
+ Usage: boardwalk workspace show [OPTIONS]
+
+ Displays the active workspace
+
+āā Options āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāā®
+ā --help Show this message and exit. ā
+ā°āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāÆ
+
+
+
+
+
+
+ Usage: boardwalk workspace use [OPTIONS] WORKSPACE_NAME
+
+āā Options āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāā®
+ā --help Show this message and exit. ā
+ā°āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāÆ
+
+
+
+
+
+
+ Usage: boardwalkd [OPTIONS] COMMAND [ARGS]...
+
+ Boardwalkd is the server component of Boardwalk. See the README.md @ https://github.com/Backblaze/boardwalk
+ for more info
+ To see more info about any subcommand, do `boardwalkd <subcommand> --help`
+
+āā Options āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāā®
+ā --help Show this message and exit. ā
+ā°āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāÆ
+āā Commands āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāā®
+ā serve Runs the server ā
+ā version Prints the boardwalk module version number and exits ā
+ā°āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāÆ
+
+
+
+
+
+
+ Usage: boardwalkd serve [OPTIONS]
+
+ Runs the server
+
+āā Options āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāā®
+ā --auth-expire-days FLOAT The number of days login tokens and user API ā
+ā keys are valid before they expire ā
+ā [default: 14] ā
+ā --auth-method [anonymous|google_oauth] Enables an authentication method for the web ā
+ā UI. The API always requires authentication, ā
+ā however without this option configured a ā
+ā predictable anonymous user will be used. The ā
+ā method is supplied as a string argument. The ā
+ā BOARDWALK_SECRET environment variable must be ā
+ā set for any method to work except for ā
+ā 'anonymous'; it is the key used to sign ā
+ā secure strings, such as auth cookies and API ā
+ā keys ā
+ā Available auth methods: ā
+ā anonymous ā
+ā All requests are performed as an 'anonymous' ā
+ā default user ā
+ā google_oauth ā
+ā Uses Google Oauth2 to identify users by their ā
+ā Google account email address. ā
+ā BOARDWALKD_GOOGLE_OAUTH_CLIENT_ID and ā
+ā BOARDWALKD_GOOGLE_OAUTH_SECRET environment ā
+ā variables must be set. The authorized ā
+ā redirect URI should be ā
+ā https://<hostname>/auth/login ā
+ā [default: anonymous] ā
+ā --develop/--no-develop Runs the server in development mode with ā
+ā auto-reloading and tracebacks ā
+ā [default: no-develop] ā
+ā * --host-header-pattern TEXT A valid python regex pattern to match ā
+ā accepted Host header values. This prevents ā
+ā DNS rebinding attacks when the pattern is ā
+ā appropriately scoped Requests reaching the ā
+ā server that don't match this pattern will ā
+ā return a 404 ā
+ā [required] ā
+ā --owner TEXT A default admin user. Every time the server ā
+ā starts up, this user will be enabled and ā
+ā added to the admin role. This option must be ā
+ā supplied when --auth-method is anything other ā
+ā than 'anonymous'. The purpose of the owner is ā
+ā to have an initial admin user available at ā
+ā first start and to avoid lock-outs ā
+ā --port INTEGER The non-TLS port number the server binds to. ā
+ā --port and/or --tls-port must be configured ā
+ā --slack-webhook-url TEXT A Slack webhook URL to broadcast all key ā
+ā events to ā
+ā [env var: BOARDWALKD_SLACK_WEBHOOK_URL] ā
+ā --slack-error-webhook-url TEXT A Slack webhook URL to broadcast error events ā
+ā to. If defined, errors will not be sent to ā
+ā the URL defined by --slack-webhook-url ā
+ā [env var: BOARDWALKD_SLACK_ERROR_WEBHOOK_URL] ā
+ā --slack-app-token TEXT A Slack App Token for the Slack App this ā
+ā Boardwalkd instance is to connect to. If ā
+ā specified, --slack-bot-token must also be ā
+ā provided. ā
+ā [env var: BOARDWALKD_SLACK_APP_TOKEN] ā
+ā --slack-bot-token TEXT A Slack OAuth Bot Token for the Slack App ā
+ā this Boardwalkd instance is to connect to. ā
+ā [env var: BOARDWALKD_SLACK_BOT_TOKEN] ā
+ā --slack-slash-command-prefix TEXT The prefix to use in front of Boardwalk slash ā
+ā commands in Slack (e.g., /PREFIX-version). ā
+ā Needs to match the prefix supplied in the ā
+ā Slack App configuration. ā
+ā [env var: ā
+ā BOARDWALKD_SLACK_SLASH_COMMAND_PREFIX] ā
+ā [default: brdwlk] ā
+ā --tls-crt PATH Path to TLS certificate chain file for use ā
+ā along with --tls-port ā
+ā --tls-key PATH Path to TLS key file for use along with ā
+ā --tls-port ā
+ā --tls-port INTEGER The TLS port number the server binds to. When ā
+ā configured, the --url option must have an ā
+ā https:// scheme. When --tls-port is ā
+ā configured, --tls-crt and --tls-key must also ā
+ā be supplied ā
+ā * --url TEXT The base URL where the server can be reached. ā
+ā UI Requests that do not match the scheme or ā
+ā host:port of this URL will automatically be ā
+ā redirected ā
+ā [required] ā
+ā --help Show this message and exit. ā
+ā°āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāÆ
+
+
+
+
+
+
+ Usage: boardwalkd version [OPTIONS]
+
+ Prints the boardwalk module version number and exits
+
+āā Options āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāā®
+ā --help Show this message and exit. ā
+ā°āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāÆ
+
+
+
Documentation generated with commit {get_git_revision_short_hash()}
+ """,
"home_page_in_toc": True,
"logo": {
"alt_text": "Boardwalk documentation - Home",
- "text": "Boardwalk, a linear Ansible workflow engine",
+ "text": f"Boardwalk, a linear Ansible workflow engine
v{VERSION}",
},
"repository_branch": "main",
"repository_url": "https://github.com/Backblaze/boardwalk/",
diff --git a/docs/source/index.md b/docs/source/index.md
index 7dd796c..b95a90f 100644
--- a/docs/source/index.md
+++ b/docs/source/index.md
@@ -4,7 +4,7 @@ gfm_only: True
-------
```{include} ../../README.md
-:end-before: GitHub-Table-of-Contents_Before
+:end-before:
```
```{toctree}
@@ -13,6 +13,7 @@ gfm_only: True
:caption: General
overview.md
+installation.md
```
```{toctree}
@@ -29,4 +30,4 @@ cli_helpdocs/index.md
:caption: API Reference
apidocs/index.rst
-```
\ No newline at end of file
+```
diff --git a/docs/source/installation.md b/docs/source/installation.md
new file mode 100644
index 0000000..338df10
--- /dev/null
+++ b/docs/source/installation.md
@@ -0,0 +1,11 @@
+-------
+# Using GitHub flavored Markdown here, as we're including portions of the README.md, which is used on GitHub.
+gfm_only: True
+-------
+
+# Installation
+
+```{include} ../../README.md
+:start-after:
+:end-before:
+```
diff --git a/docs/source/overview.md b/docs/source/overview.md
index 2336cd4..01b1843 100644
--- a/docs/source/overview.md
+++ b/docs/source/overview.md
@@ -6,5 +6,5 @@ gfm_only: True
# Overview
```{include} ../../README.md
-:start-after: GitHub-Table-of-Contents_After -->
+:start-after:
```
From 453948dff5bf15d233f053e5875a6c69deed48cf Mon Sep 17 00:00:00 2001
From: Alex Sullivan <115666116+asullivan-blze@users.noreply.github.com>
Date: Fri, 8 Nov 2024 11:46:19 -0800
Subject: [PATCH 4/6] - Lowers the HTML build artifact retention to 14 days -
Cleans up code bits used during development - Removes the Git SHA from the
generated page footer; we still have the short SHA and the version in the
page heading, so nothing is really missing by not including this.
---
.github/workflows/sphinx.yml | 26 +++++++++++---------------
docs/source/conf.py | 20 ++++++--------------
2 files changed, 17 insertions(+), 29 deletions(-)
diff --git a/.github/workflows/sphinx.yml b/.github/workflows/sphinx.yml
index 63eb38d..b821c7d 100644
--- a/.github/workflows/sphinx.yml
+++ b/.github/workflows/sphinx.yml
@@ -1,13 +1,13 @@
name: "Sphinx: Render docs"
on:
- pull_request:
+ pull_request: {}
push:
branches:
- main
tags:
- 'v*.*.*'
- workflow_dispatch:
+ workflow_dispatch: {}
jobs:
build:
@@ -70,20 +70,16 @@ jobs:
uses: actions/upload-artifact@v4
with:
name: html-docs
- path: docs/build/
+ # Lower default retention -- the artifacts can be rebuilt from source, if needed
+ retention-days: 14
+ # Don't include the doctrees subdir; it's just pickled data Sphinx generates to make the HTML
+ path: |
+ docs/build/
+ !docs/build/doctrees
- # - name: Deploy main branch docs to gh-pages branch
- # uses: peaceiris/actions-gh-pages@v4
- # if: github.ref == 'refs/heads/main'
- # with:
- # github_token: ${{ secrets.GITHUB_TOKEN }}
- # publish_dir: docs/build/
-
- # Since it doesn't seem GHActions supports `or`, using this as an intermediate testing step.
- # The above will remain once we merge this workflow back into the main repo.
- - name: Deploy testing docs to gh-pages branch
+ - name: Deploy documentation to the gh-pages branch for publishing
uses: peaceiris/actions-gh-pages@v4
- if: github.ref == 'refs/heads/dev'
+ if: github.ref == 'refs/heads/main'
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
- publish_dir: docs/build/
+ publish_dir: docs/build/html
diff --git a/docs/source/conf.py b/docs/source/conf.py
index c23f44e..8c90eab 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -7,17 +7,6 @@
from datetime import UTC, datetime
from importlib.metadata import version as lib_version
-# -- Helper functions -----------------------------------------------------
-
-
-def get_git_revision_hash() -> str:
- return subprocess.check_output(["git", "rev-parse", "HEAD"]).decode("ascii").strip()
-
-
-def get_git_revision_short_hash() -> str:
- return subprocess.check_output(["git", "rev-parse", "--short", "HEAD"]).decode("ascii").strip()
-
-
# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
@@ -28,6 +17,12 @@ def get_git_revision_short_hash() -> str:
release = f"v{VERSION}"
version = VERSION
+# -- Helper functions -----------------------------------------------------
+
+
+def get_git_revision_short_hash() -> str:
+ return subprocess.check_output(["git", "rev-parse", "--short", "HEAD"]).decode("ascii").strip()
+
# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
@@ -116,9 +111,6 @@ def get_git_revision_short_hash() -> str:
# html_favicon = "_static/logo-square.svg"
html_title = f"Boardwalk v{VERSION} ({get_git_revision_short_hash()})"
html_theme_options = {
- "extra_footer": f"""
- Documentation generated with commit {get_git_revision_short_hash()}
- """,
"home_page_in_toc": True,
"logo": {
"alt_text": "Boardwalk documentation - Home",
From 80bdbe6d87a32861c17974864896f5c1c902774c Mon Sep 17 00:00:00 2001
From: Alex Sullivan <115666116+asullivan-blze@users.noreply.github.com>
Date: Fri, 8 Nov 2024 13:20:32 -0800
Subject: [PATCH 5/6] Remove development artifact from GH action which wasn't
eventually used
---
.github/dependabot.yml | 5 -----
docs/requirements.txt | 8 --------
2 files changed, 13 deletions(-)
delete mode 100644 docs/requirements.txt
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
index af35054..2a21467 100644
--- a/.github/dependabot.yml
+++ b/.github/dependabot.yml
@@ -8,11 +8,6 @@ updates:
directory: "/"
schedule:
interval: "daily"
- # Keep the requirements.txt for Sphinx builds in `/docs` up to date, also.
- - package-ecosystem: "pip"
- directory: "/docs"
- schedule:
- interval: "daily"
# For keeping workflows up-to-date.
- package-ecosystem: "github-actions"
directory: "/"
diff --git a/docs/requirements.txt b/docs/requirements.txt
deleted file mode 100644
index db831ac..0000000
--- a/docs/requirements.txt
+++ /dev/null
@@ -1,8 +0,0 @@
-# Requirements file for the GitHub ammaraskar/sphinx-action, which builds Sphinx
-# documentation
-
-sphinx-autobuild >= 2024.10.3
-sphinx-autodoc2 >= 0.5.0, < 1.0
-sphinx-book-theme >= 1.1.3, < 2.0
-sphinx-copybutton >= 0.5.2, < 1.0
-myst-parser [linkify] >= 4.0.0, < 5.0
From 7d610408ccf0a5c765778f00dd9a7f134b0637a6 Mon Sep 17 00:00:00 2001
From: Alex Sullivan <115666116+asullivan-blze@users.noreply.github.com>
Date: Tue, 12 Nov 2024 17:10:53 -0800
Subject: [PATCH 6/6] Auto-generate automatic documentation at document
build-time
There's little reason to include the files that would get built and/or rebuilt by Sphinx. Avoids bloated diffs.
---
.github/workflows/sphinx.yml | 85 --
.gitignore | 2 +
Makefile | 3 +-
README.md | 3 +-
docs/Makefile | 18 +-
docs/build_cli_help_pages.sh | 10 +-
.../apidocs/boardwalk/boardwalk.__main__.md | 8 -
.../apidocs/boardwalk/boardwalk.ansible.md | 144 ---
.../boardwalk/boardwalk.app_exceptions.md | 36 -
.../source/apidocs/boardwalk/boardwalk.cli.md | 75 --
.../apidocs/boardwalk/boardwalk.cli_catch.md | 42 -
.../apidocs/boardwalk/boardwalk.cli_init.md | 53 -
.../apidocs/boardwalk/boardwalk.cli_login.md | 31 -
.../apidocs/boardwalk/boardwalk.cli_run.md | 289 -----
.../boardwalk/boardwalk.cli_workspace.md | 97 --
.../apidocs/boardwalk/boardwalk.host.md | 211 ----
.../apidocs/boardwalk/boardwalk.manifest.md | 610 ----------
docs/source/apidocs/boardwalk/boardwalk.md | 29 -
.../apidocs/boardwalk/boardwalk.state.md | 186 ---
.../apidocs/boardwalk/boardwalk.utils.md | 31 -
.../apidocs/boardwalkd/boardwalkd.__main__.md | 8 -
.../boardwalkd/boardwalkd.broadcast.md | 32 -
.../apidocs/boardwalkd/boardwalkd.cli.md | 76 --
docs/source/apidocs/boardwalkd/boardwalkd.md | 23 -
.../apidocs/boardwalkd/boardwalkd.protocol.md | 554 ---------
.../apidocs/boardwalkd/boardwalkd.server.md | 1005 -----------------
.../apidocs/boardwalkd/boardwalkd.slack.md | 207 ----
.../apidocs/boardwalkd/boardwalkd.state.md | 305 -----
docs/source/apidocs/index.rst | 12 -
.../cli_helpdocs/boardwalk/boardwalk.md | 33 -
.../cli_helpdocs/boardwalk/boardwalk_catch.md | 18 -
.../cli_helpdocs/boardwalk/boardwalk_check.md | 32 -
.../cli_helpdocs/boardwalk/boardwalk_init.md | 23 -
.../cli_helpdocs/boardwalk/boardwalk_login.md | 17 -
.../boardwalk/boardwalk_release.md | 17 -
.../cli_helpdocs/boardwalk/boardwalk_run.md | 40 -
.../boardwalk/boardwalk_version.md | 17 -
.../boardwalk/boardwalk_workspace.md | 22 -
.../boardwalk/boardwalk_workspace_dump.md | 17 -
.../boardwalk/boardwalk_workspace_list.md | 17 -
.../boardwalk/boardwalk_workspace_reset.md | 18 -
.../boardwalk/boardwalk_workspace_show.md | 17 -
.../boardwalk/boardwalk_workspace_use.md | 15 -
docs/source/cli_helpdocs/boardwalk/index.md | 34 +-
.../cli_helpdocs/boardwalkd/boardwalkd.md | 23 -
.../boardwalkd/boardwalkd_serve.md | 98 --
.../boardwalkd/boardwalkd_version.md | 17 -
docs/source/cli_helpdocs/boardwalkd/index.md | 12 +-
docs/source/cli_helpdocs/index.md | 6 +-
docs/source/conf.py | 5 +-
docs/source/index.md | 2 +-
51 files changed, 66 insertions(+), 4619 deletions(-)
delete mode 100644 .github/workflows/sphinx.yml
delete mode 100644 docs/source/apidocs/boardwalk/boardwalk.__main__.md
delete mode 100644 docs/source/apidocs/boardwalk/boardwalk.ansible.md
delete mode 100644 docs/source/apidocs/boardwalk/boardwalk.app_exceptions.md
delete mode 100644 docs/source/apidocs/boardwalk/boardwalk.cli.md
delete mode 100644 docs/source/apidocs/boardwalk/boardwalk.cli_catch.md
delete mode 100644 docs/source/apidocs/boardwalk/boardwalk.cli_init.md
delete mode 100644 docs/source/apidocs/boardwalk/boardwalk.cli_login.md
delete mode 100644 docs/source/apidocs/boardwalk/boardwalk.cli_run.md
delete mode 100644 docs/source/apidocs/boardwalk/boardwalk.cli_workspace.md
delete mode 100644 docs/source/apidocs/boardwalk/boardwalk.host.md
delete mode 100644 docs/source/apidocs/boardwalk/boardwalk.manifest.md
delete mode 100644 docs/source/apidocs/boardwalk/boardwalk.md
delete mode 100644 docs/source/apidocs/boardwalk/boardwalk.state.md
delete mode 100644 docs/source/apidocs/boardwalk/boardwalk.utils.md
delete mode 100644 docs/source/apidocs/boardwalkd/boardwalkd.__main__.md
delete mode 100644 docs/source/apidocs/boardwalkd/boardwalkd.broadcast.md
delete mode 100644 docs/source/apidocs/boardwalkd/boardwalkd.cli.md
delete mode 100644 docs/source/apidocs/boardwalkd/boardwalkd.md
delete mode 100644 docs/source/apidocs/boardwalkd/boardwalkd.protocol.md
delete mode 100644 docs/source/apidocs/boardwalkd/boardwalkd.server.md
delete mode 100644 docs/source/apidocs/boardwalkd/boardwalkd.slack.md
delete mode 100644 docs/source/apidocs/boardwalkd/boardwalkd.state.md
delete mode 100644 docs/source/apidocs/index.rst
delete mode 100644 docs/source/cli_helpdocs/boardwalk/boardwalk.md
delete mode 100644 docs/source/cli_helpdocs/boardwalk/boardwalk_catch.md
delete mode 100644 docs/source/cli_helpdocs/boardwalk/boardwalk_check.md
delete mode 100644 docs/source/cli_helpdocs/boardwalk/boardwalk_init.md
delete mode 100644 docs/source/cli_helpdocs/boardwalk/boardwalk_login.md
delete mode 100644 docs/source/cli_helpdocs/boardwalk/boardwalk_release.md
delete mode 100644 docs/source/cli_helpdocs/boardwalk/boardwalk_run.md
delete mode 100644 docs/source/cli_helpdocs/boardwalk/boardwalk_version.md
delete mode 100644 docs/source/cli_helpdocs/boardwalk/boardwalk_workspace.md
delete mode 100644 docs/source/cli_helpdocs/boardwalk/boardwalk_workspace_dump.md
delete mode 100644 docs/source/cli_helpdocs/boardwalk/boardwalk_workspace_list.md
delete mode 100644 docs/source/cli_helpdocs/boardwalk/boardwalk_workspace_reset.md
delete mode 100644 docs/source/cli_helpdocs/boardwalk/boardwalk_workspace_show.md
delete mode 100644 docs/source/cli_helpdocs/boardwalk/boardwalk_workspace_use.md
delete mode 100644 docs/source/cli_helpdocs/boardwalkd/boardwalkd.md
delete mode 100644 docs/source/cli_helpdocs/boardwalkd/boardwalkd_serve.md
delete mode 100644 docs/source/cli_helpdocs/boardwalkd/boardwalkd_version.md
diff --git a/.github/workflows/sphinx.yml b/.github/workflows/sphinx.yml
deleted file mode 100644
index b821c7d..0000000
--- a/.github/workflows/sphinx.yml
+++ /dev/null
@@ -1,85 +0,0 @@
-name: "Sphinx: Render docs"
-
-on:
- pull_request: {}
- push:
- branches:
- - main
- tags:
- - 'v*.*.*'
- workflow_dispatch: {}
-
-jobs:
- build:
- runs-on: ubuntu-latest
- concurrency:
- group: ${{ github.workflow }}-${{ github.ref }}
- permissions:
- contents: write
- steps:
- #----------------------------------------------
- # check-out repo and set-up python
- #----------------------------------------------
- - name: Check out repository
- uses: actions/checkout@v4
-
- - name: Set up python
- id: setup-python
- uses: actions/setup-python@v5.3.0
- with:
- python-version: '3.11'
-
- #----------------------------------------------
- # Install and configure Poetry, or restore from cache
- #----------------------------------------------
- - name: Load cached Poetry installation
- id: cached-poetry
- uses: actions/cache@v4.1.2
- with:
- path: ~/.local # the path depends on the OS
- key: poetry-docs-0 # increment to reset cache
-
- - name: Install Poetry
- if: steps.cached-poetry.outputs.cache-hit != 'true'
- uses: snok/install-poetry@v1
- with:
- virtualenvs-create: true
- virtualenvs-in-project: true
- installer-parallel: true
-
- #----------------------------------------------
- # load cached venv if cache exists
- #----------------------------------------------
- - name: Load cached venv
- id: cached-poetry-dependencies
- uses: actions/cache@v4.1.2
- with:
- path: .venv
- key: boardwalk-docs-venv-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('**/poetry.lock') }}
-
- #----------------------------------------------
- # install your root project, if required
- #----------------------------------------------
- - name: Install project, with dependencies foor building documentation
- run: poetry install --no-interaction --with=docs --sync
-
- - name: Run 'make docs', to build documentation
- run: poetry run make docs
-
- - name: Upload artifacts
- uses: actions/upload-artifact@v4
- with:
- name: html-docs
- # Lower default retention -- the artifacts can be rebuilt from source, if needed
- retention-days: 14
- # Don't include the doctrees subdir; it's just pickled data Sphinx generates to make the HTML
- path: |
- docs/build/
- !docs/build/doctrees
-
- - name: Deploy documentation to the gh-pages branch for publishing
- uses: peaceiris/actions-gh-pages@v4
- if: github.ref == 'refs/heads/main'
- with:
- github_token: ${{ secrets.GITHUB_TOKEN }}
- publish_dir: docs/build/html
diff --git a/.gitignore b/.gitignore
index 12af726..0beaa84 100644
--- a/.gitignore
+++ b/.gitignore
@@ -9,3 +9,5 @@ __pycache__/
*.egg-info/
build/
dist/
+# Contains files which are automatically generated by the documentation build process.
+docs/source/_autogenerated
diff --git a/Makefile b/Makefile
index 7ab6159..a7aa6b0 100644
--- a/Makefile
+++ b/Makefile
@@ -11,8 +11,9 @@ container:
clean:
set -o pipefail
- @echo '[.] Removing built packages ...'
+ @echo '[.] Removing built packages and documentation ...'
rm -rf dist/
+ make --directory=./docs/ clean
@echo '[.] Cleaning __pycache__ directories ...'
find . -type d -name '__pycache__' | xargs rm -rf
diff --git a/README.md b/README.md
index 883a86e..1e5d18e 100644
--- a/README.md
+++ b/README.md
@@ -23,6 +23,7 @@ updates.__ š„
# Table of Contents
- [Motivation & Goals](#motivation--goals)
+- [Installation](#installation)
- [Open-Source License](#open-source-license)
- [Contributing](#contributing)
- [Concepts](#concepts)
@@ -32,7 +33,6 @@ updates.__ š„
- [Local State](#local-state)
- [Remote State](#remote-state)
- [Usage](#usage)
- - [Installation](#installation)
- [The `Boardwalkfile.py`](#the-boardwalkfilepy)
- [Command-line Interface](#environment-variables)
- [`boardwalkd` Server](#boardwalkd-server)
@@ -223,7 +223,6 @@ Boardwalk.
# Usage
-(the-boardwalkfilepy)=
## The `Boardwalkfile.py`
Boardwalk is both a python library and command-line tool. The `boardwalk`
diff --git a/docs/Makefile b/docs/Makefile
index c99ffc2..2e53837 100644
--- a/docs/Makefile
+++ b/docs/Makefile
@@ -9,14 +9,28 @@ SOURCEDIR = source
BUILDDIR = build
# Put it first so that "make" without argument is like "make help".
+.PHONY: help Makefile
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
-.PHONY: help Makefile
+
+# Define some build targets manually, since we also have the auto-generated documentation to handle
+.PHONY: clean
+clean:
+ @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+ -rm -r source/_autogenerated
+
+.PHONY: generate_cli_help_page_sources
+generate_cli_help_page_sources:
+ ./build_cli_help_pages.sh
+
+.PHONY: html
+html: generate_cli_help_page_sources
+ @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
-livehtml:
+livehtml: generate_cli_help_page_sources
sphinx-autobuild "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/docs/build_cli_help_pages.sh b/docs/build_cli_help_pages.sh
index 7ce4220..b5f3351 100755
--- a/docs/build_cli_help_pages.sh
+++ b/docs/build_cli_help_pages.sh
@@ -30,6 +30,11 @@ GET_PAGE_NAME() {
echo '`'"$1"'`'
}
+AUTO_GEN_DIR=source/_autogenerated/cli_helpdocs
+mkdir -p "$AUTO_GEN_DIR"
+mkdir -p "$AUTO_GEN_DIR/boardwalk"
+mkdir -p "$AUTO_GEN_DIR/boardwalkd"
+
for cmd in "${commands[@]}"; do
# Define regular expression patterns for 'boardwalk' and 'boardwalkd', so we
# can sort them into the correct subdirectories. Note that we need to use
@@ -47,8 +52,9 @@ for cmd in "${commands[@]}"; do
echo "[!] Skipping generation for $cmd; is this a boardwalk or boardwalkd command?"
continue
fi
- FILENAME=./source/cli_helpdocs/$SUBDIR/$(echo "$cmd" | tr ' ' _).md
- echo "[+] Generating doc page for $FILENAME"
+ FILENAME=$AUTO_GEN_DIR/$SUBDIR/$(echo "$cmd" | tr ' ' _).md
+ echo "[+] Generating doc page for $cmd"
+ touch "$FILENAME"
{
echo "# $(GET_PAGE_NAME "$cmd")"
echo ""
diff --git a/docs/source/apidocs/boardwalk/boardwalk.__main__.md b/docs/source/apidocs/boardwalk/boardwalk.__main__.md
deleted file mode 100644
index 2c9c9d2..0000000
--- a/docs/source/apidocs/boardwalk/boardwalk.__main__.md
+++ /dev/null
@@ -1,8 +0,0 @@
-# {py:mod}`boardwalk.__main__`
-
-```{py:module} boardwalk.__main__
-```
-
-```{autodoc2-docstring} boardwalk.__main__
-:allowtitles:
-```
diff --git a/docs/source/apidocs/boardwalk/boardwalk.ansible.md b/docs/source/apidocs/boardwalk/boardwalk.ansible.md
deleted file mode 100644
index 32c2cd6..0000000
--- a/docs/source/apidocs/boardwalk/boardwalk.ansible.md
+++ /dev/null
@@ -1,144 +0,0 @@
-# {py:mod}`boardwalk.ansible`
-
-```{py:module} boardwalk.ansible
-```
-
-```{autodoc2-docstring} boardwalk.ansible
-:allowtitles:
-```
-
-## Module Contents
-
-### Functions
-
-````{list-table}
-:class: autosummary longtable
-:align: left
-
-* - {py:obj}`ansible_runner_cancel_callback `
- - ```{autodoc2-docstring} boardwalk.ansible.ansible_runner_cancel_callback
- :summary:
- ```
-* - {py:obj}`ansible_runner_errors_to_output `
- - ```{autodoc2-docstring} boardwalk.ansible.ansible_runner_errors_to_output
- :summary:
- ```
-* - {py:obj}`ansible_runner_run_tasks `
- - ```{autodoc2-docstring} boardwalk.ansible.ansible_runner_run_tasks
- :summary:
- ```
-* - {py:obj}`ansible_inventory `
- - ```{autodoc2-docstring} boardwalk.ansible.ansible_inventory
- :summary:
- ```
-````
-
-### API
-
-````{py:function} ansible_runner_cancel_callback(ws: boardwalk.manifest.Workspace)
-:canonical: boardwalk.ansible.ansible_runner_cancel_callback
-
-```{autodoc2-docstring} boardwalk.ansible.ansible_runner_cancel_callback
-```
-````
-
-````{py:function} ansible_runner_errors_to_output(runner: ansible_runner.Runner, include_msg: bool = True) -> str
-:canonical: boardwalk.ansible.ansible_runner_errors_to_output
-
-```{autodoc2-docstring} boardwalk.ansible.ansible_runner_errors_to_output
-```
-````
-
-````{py:function} ansible_runner_run_tasks(hosts: str, invocation_msg: str, job_type: boardwalk.manifest.JobTypes, tasks: boardwalk.ansible.AnsibleTasksType, become: bool = False, become_password: str | None = None, check: bool = False, gather_facts: bool = True, limit: str | None = None, quiet: bool = True, timeout: int | None = None, verbosity: int = 0, extra_vars: dict = {}) -> ansible_runner.Runner
-:canonical: boardwalk.ansible.ansible_runner_run_tasks
-
-```{autodoc2-docstring} boardwalk.ansible.ansible_runner_run_tasks
-```
-````
-
-````{py:function} ansible_inventory() -> boardwalk.ansible.InventoryData
-:canonical: boardwalk.ansible.ansible_inventory
-
-```{autodoc2-docstring} boardwalk.ansible.ansible_inventory
-```
-````
-
-````{py:exception} AnsibleRunnerBaseException(message: str, runner_msg: str, runner: ansible_runner.Runner)
-:canonical: boardwalk.ansible.AnsibleRunnerBaseException
-
-Bases: {py:obj}`Exception`
-
-```{autodoc2-docstring} boardwalk.ansible.AnsibleRunnerBaseException
-```
-
-```{rubric} Initialization
-```
-
-```{autodoc2-docstring} boardwalk.ansible.AnsibleRunnerBaseException.__init__
-```
-
-````
-
-````{py:exception} AnsibleRunnerGeneralError(message: str, runner_msg: str, runner: ansible_runner.Runner)
-:canonical: boardwalk.ansible.AnsibleRunnerGeneralError
-
-Bases: {py:obj}`boardwalk.ansible.AnsibleRunnerBaseException`
-
-```{autodoc2-docstring} boardwalk.ansible.AnsibleRunnerGeneralError
-```
-
-```{rubric} Initialization
-```
-
-```{autodoc2-docstring} boardwalk.ansible.AnsibleRunnerGeneralError.__init__
-```
-
-````
-
-````{py:exception} AnsibleRunError(message: str, runner_msg: str, runner: ansible_runner.Runner)
-:canonical: boardwalk.ansible.AnsibleRunError
-
-Bases: {py:obj}`boardwalk.ansible.AnsibleRunnerBaseException`
-
-```{autodoc2-docstring} boardwalk.ansible.AnsibleRunError
-```
-
-```{rubric} Initialization
-```
-
-```{autodoc2-docstring} boardwalk.ansible.AnsibleRunError.__init__
-```
-
-````
-
-````{py:exception} AnsibleRunnerUnreachableHost(message: str, runner_msg: str, runner: ansible_runner.Runner)
-:canonical: boardwalk.ansible.AnsibleRunnerUnreachableHost
-
-Bases: {py:obj}`boardwalk.ansible.AnsibleRunnerBaseException`
-
-```{autodoc2-docstring} boardwalk.ansible.AnsibleRunnerUnreachableHost
-```
-
-```{rubric} Initialization
-```
-
-```{autodoc2-docstring} boardwalk.ansible.AnsibleRunnerUnreachableHost.__init__
-```
-
-````
-
-````{py:exception} AnsibleRunnerFailedHost(message: str, runner_msg: str, runner: ansible_runner.Runner)
-:canonical: boardwalk.ansible.AnsibleRunnerFailedHost
-
-Bases: {py:obj}`boardwalk.ansible.AnsibleRunnerBaseException`
-
-```{autodoc2-docstring} boardwalk.ansible.AnsibleRunnerFailedHost
-```
-
-```{rubric} Initialization
-```
-
-```{autodoc2-docstring} boardwalk.ansible.AnsibleRunnerFailedHost.__init__
-```
-
-````
diff --git a/docs/source/apidocs/boardwalk/boardwalk.app_exceptions.md b/docs/source/apidocs/boardwalk/boardwalk.app_exceptions.md
deleted file mode 100644
index 23c03eb..0000000
--- a/docs/source/apidocs/boardwalk/boardwalk.app_exceptions.md
+++ /dev/null
@@ -1,36 +0,0 @@
-# {py:mod}`boardwalk.app_exceptions`
-
-```{py:module} boardwalk.app_exceptions
-```
-
-```{autodoc2-docstring} boardwalk.app_exceptions
-:allowtitles:
-```
-
-## Module Contents
-
-### API
-
-`````{py:exception} BoardwalkException(message: str)
-:canonical: boardwalk.app_exceptions.BoardwalkException
-
-Bases: {py:obj}`click.ClickException`
-
-```{autodoc2-docstring} boardwalk.app_exceptions.BoardwalkException
-```
-
-```{rubric} Initialization
-```
-
-```{autodoc2-docstring} boardwalk.app_exceptions.BoardwalkException.__init__
-```
-
-````{py:method} show(file: typing.IO[str] | None = None) -> None
-:canonical: boardwalk.app_exceptions.BoardwalkException.show
-
-```{autodoc2-docstring} boardwalk.app_exceptions.BoardwalkException.show
-```
-
-````
-
-`````
diff --git a/docs/source/apidocs/boardwalk/boardwalk.cli.md b/docs/source/apidocs/boardwalk/boardwalk.cli.md
deleted file mode 100644
index b693e4e..0000000
--- a/docs/source/apidocs/boardwalk/boardwalk.cli.md
+++ /dev/null
@@ -1,75 +0,0 @@
-# {py:mod}`boardwalk.cli`
-
-```{py:module} boardwalk.cli
-```
-
-```{autodoc2-docstring} boardwalk.cli
-:allowtitles:
-```
-
-## Module Contents
-
-### Functions
-
-````{list-table}
-:class: autosummary longtable
-:align: left
-
-* - {py:obj}`handle_signal `
- - ```{autodoc2-docstring} boardwalk.cli.handle_signal
- :summary:
- ```
-* - {py:obj}`cli `
- - ```{autodoc2-docstring} boardwalk.cli.cli
- :summary:
- ```
-* - {py:obj}`version `
- - ```{autodoc2-docstring} boardwalk.cli.version
- :summary:
- ```
-````
-
-### Data
-
-````{list-table}
-:class: autosummary longtable
-:align: left
-
-* - {py:obj}`terminating `
- - ```{autodoc2-docstring} boardwalk.cli.terminating
- :summary:
- ```
-````
-
-### API
-
-````{py:data} terminating
-:canonical: boardwalk.cli.terminating
-:value: >
- False
-
-```{autodoc2-docstring} boardwalk.cli.terminating
-```
-
-````
-
-````{py:function} handle_signal(sig: int, frame: typing.Any)
-:canonical: boardwalk.cli.handle_signal
-
-```{autodoc2-docstring} boardwalk.cli.handle_signal
-```
-````
-
-````{py:function} cli(ctx: click.Context, verbose: int)
-:canonical: boardwalk.cli.cli
-
-```{autodoc2-docstring} boardwalk.cli.cli
-```
-````
-
-````{py:function} version()
-:canonical: boardwalk.cli.version
-
-```{autodoc2-docstring} boardwalk.cli.version
-```
-````
diff --git a/docs/source/apidocs/boardwalk/boardwalk.cli_catch.md b/docs/source/apidocs/boardwalk/boardwalk.cli_catch.md
deleted file mode 100644
index 0d7af96..0000000
--- a/docs/source/apidocs/boardwalk/boardwalk.cli_catch.md
+++ /dev/null
@@ -1,42 +0,0 @@
-# {py:mod}`boardwalk.cli_catch`
-
-```{py:module} boardwalk.cli_catch
-```
-
-```{autodoc2-docstring} boardwalk.cli_catch
-:allowtitles:
-```
-
-## Module Contents
-
-### Functions
-
-````{list-table}
-:class: autosummary longtable
-:align: left
-
-* - {py:obj}`catch `
- - ```{autodoc2-docstring} boardwalk.cli_catch.catch
- :summary:
- ```
-* - {py:obj}`release `
- - ```{autodoc2-docstring} boardwalk.cli_catch.release
- :summary:
- ```
-````
-
-### API
-
-````{py:function} catch()
-:canonical: boardwalk.cli_catch.catch
-
-```{autodoc2-docstring} boardwalk.cli_catch.catch
-```
-````
-
-````{py:function} release()
-:canonical: boardwalk.cli_catch.release
-
-```{autodoc2-docstring} boardwalk.cli_catch.release
-```
-````
diff --git a/docs/source/apidocs/boardwalk/boardwalk.cli_init.md b/docs/source/apidocs/boardwalk/boardwalk.cli_init.md
deleted file mode 100644
index 2bc9fb0..0000000
--- a/docs/source/apidocs/boardwalk/boardwalk.cli_init.md
+++ /dev/null
@@ -1,53 +0,0 @@
-# {py:mod}`boardwalk.cli_init`
-
-```{py:module} boardwalk.cli_init
-```
-
-```{autodoc2-docstring} boardwalk.cli_init
-:allowtitles:
-```
-
-## Module Contents
-
-### Functions
-
-````{list-table}
-:class: autosummary longtable
-:align: left
-
-* - {py:obj}`init `
- - ```{autodoc2-docstring} boardwalk.cli_init.init
- :summary:
- ```
-* - {py:obj}`add_gathered_facts_to_state `
- - ```{autodoc2-docstring} boardwalk.cli_init.add_gathered_facts_to_state
- :summary:
- ```
-* - {py:obj}`handle_failed_init_hosts `
- - ```{autodoc2-docstring} boardwalk.cli_init.handle_failed_init_hosts
- :summary:
- ```
-````
-
-### API
-
-````{py:function} init(ctx: click.Context, limit: str, retry: bool)
-:canonical: boardwalk.cli_init.init
-
-```{autodoc2-docstring} boardwalk.cli_init.init
-```
-````
-
-````{py:function} add_gathered_facts_to_state(event: ansible_runner.RunnerEvent, ws: boardwalk.manifest.Workspace)
-:canonical: boardwalk.cli_init.add_gathered_facts_to_state
-
-```{autodoc2-docstring} boardwalk.cli_init.add_gathered_facts_to_state
-```
-````
-
-````{py:function} handle_failed_init_hosts(event: ansible_runner.RunnerEvent, retry_file_path: pathlib.Path)
-:canonical: boardwalk.cli_init.handle_failed_init_hosts
-
-```{autodoc2-docstring} boardwalk.cli_init.handle_failed_init_hosts
-```
-````
diff --git a/docs/source/apidocs/boardwalk/boardwalk.cli_login.md b/docs/source/apidocs/boardwalk/boardwalk.cli_login.md
deleted file mode 100644
index 906cc41..0000000
--- a/docs/source/apidocs/boardwalk/boardwalk.cli_login.md
+++ /dev/null
@@ -1,31 +0,0 @@
-# {py:mod}`boardwalk.cli_login`
-
-```{py:module} boardwalk.cli_login
-```
-
-```{autodoc2-docstring} boardwalk.cli_login
-:allowtitles:
-```
-
-## Module Contents
-
-### Functions
-
-````{list-table}
-:class: autosummary longtable
-:align: left
-
-* - {py:obj}`login `
- - ```{autodoc2-docstring} boardwalk.cli_login.login
- :summary:
- ```
-````
-
-### API
-
-````{py:function} login()
-:canonical: boardwalk.cli_login.login
-
-```{autodoc2-docstring} boardwalk.cli_login.login
-```
-````
diff --git a/docs/source/apidocs/boardwalk/boardwalk.cli_run.md b/docs/source/apidocs/boardwalk/boardwalk.cli_run.md
deleted file mode 100644
index 488349e..0000000
--- a/docs/source/apidocs/boardwalk/boardwalk.cli_run.md
+++ /dev/null
@@ -1,289 +0,0 @@
-# {py:mod}`boardwalk.cli_run`
-
-```{py:module} boardwalk.cli_run
-```
-
-```{autodoc2-docstring} boardwalk.cli_run
-:allowtitles:
-```
-
-## Module Contents
-
-### Functions
-
-````{list-table}
-:class: autosummary longtable
-:align: left
-
-* - {py:obj}`run `
- - ```{autodoc2-docstring} boardwalk.cli_run.run
- :summary:
- ```
-* - {py:obj}`check `
- - ```{autodoc2-docstring} boardwalk.cli_run.check
- :summary:
- ```
-* - {py:obj}`run_workflow `
- - ```{autodoc2-docstring} boardwalk.cli_run.run_workflow
- :summary:
- ```
-* - {py:obj}`run_failure_mode_handler `
- - ```{autodoc2-docstring} boardwalk.cli_run.run_failure_mode_handler
- :summary:
- ```
-* - {py:obj}`filter_hosts_by_limit `
- - ```{autodoc2-docstring} boardwalk.cli_run.filter_hosts_by_limit
- :summary:
- ```
-* - {py:obj}`sort_host_list `
- - ```{autodoc2-docstring} boardwalk.cli_run.sort_host_list
- :summary:
- ```
-* - {py:obj}`check_host_preconditions_locally `
- - ```{autodoc2-docstring} boardwalk.cli_run.check_host_preconditions_locally
- :summary:
- ```
-* - {py:obj}`handle_workflow_catch `
- - ```{autodoc2-docstring} boardwalk.cli_run.handle_workflow_catch
- :summary:
- ```
-* - {py:obj}`lock_remote_host `
- - ```{autodoc2-docstring} boardwalk.cli_run.lock_remote_host
- :summary:
- ```
-* - {py:obj}`bootstrap_with_server `
- - ```{autodoc2-docstring} boardwalk.cli_run.bootstrap_with_server
- :summary:
- ```
-* - {py:obj}`update_host_facts_in_local_state `
- - ```{autodoc2-docstring} boardwalk.cli_run.update_host_facts_in_local_state
- :summary:
- ```
-* - {py:obj}`directly_confirm_host_preconditions `
- - ```{autodoc2-docstring} boardwalk.cli_run.directly_confirm_host_preconditions
- :summary:
- ```
-* - {py:obj}`execute_workflow_jobs `
- - ```{autodoc2-docstring} boardwalk.cli_run.execute_workflow_jobs
- :summary:
- ```
-* - {py:obj}`execute_host_workflow `
- - ```{autodoc2-docstring} boardwalk.cli_run.execute_host_workflow
- :summary:
- ```
-````
-
-### Data
-
-````{list-table}
-:class: autosummary longtable
-:align: left
-
-* - {py:obj}`become_password `
- - ```{autodoc2-docstring} boardwalk.cli_run.become_password
- :summary:
- ```
-* - {py:obj}`boardwalkd_client `
- - ```{autodoc2-docstring} boardwalk.cli_run.boardwalkd_client
- :summary:
- ```
-* - {py:obj}`boardwalkd_send_broadcasts `
- - ```{autodoc2-docstring} boardwalk.cli_run.boardwalkd_send_broadcasts
- :summary:
- ```
-* - {py:obj}`_check_mode `
- - ```{autodoc2-docstring} boardwalk.cli_run._check_mode
- :summary:
- ```
-* - {py:obj}`_stomp_locks `
- - ```{autodoc2-docstring} boardwalk.cli_run._stomp_locks
- :summary:
- ```
-````
-
-### API
-
-````{py:data} become_password
-:canonical: boardwalk.cli_run.become_password
-:type: str | None
-:value: >
- None
-
-```{autodoc2-docstring} boardwalk.cli_run.become_password
-```
-
-````
-
-````{py:data} boardwalkd_client
-:canonical: boardwalk.cli_run.boardwalkd_client
-:type: boardwalkd.protocol.WorkspaceClient | None
-:value: >
- None
-
-```{autodoc2-docstring} boardwalk.cli_run.boardwalkd_client
-```
-
-````
-
-````{py:data} boardwalkd_send_broadcasts
-:canonical: boardwalk.cli_run.boardwalkd_send_broadcasts
-:type: bool
-:value: >
- False
-
-```{autodoc2-docstring} boardwalk.cli_run.boardwalkd_send_broadcasts
-```
-
-````
-
-````{py:data} _check_mode
-:canonical: boardwalk.cli_run._check_mode
-:type: bool
-:value: >
- True
-
-```{autodoc2-docstring} boardwalk.cli_run._check_mode
-```
-
-````
-
-````{py:data} _stomp_locks
-:canonical: boardwalk.cli_run._stomp_locks
-:type: bool
-:value: >
- False
-
-```{autodoc2-docstring} boardwalk.cli_run._stomp_locks
-```
-
-````
-
-````{py:function} run(ctx: click.Context, ask_become_pass: bool, check: bool, limit: str, server_connect: bool, sort_hosts: str, stomp_locks: bool)
-:canonical: boardwalk.cli_run.run
-
-```{autodoc2-docstring} boardwalk.cli_run.run
-```
-````
-
-````{py:function} check(ctx: click.Context, ask_become_pass: bool, limit: str, server_connect: bool, sort_hosts: str)
-:canonical: boardwalk.cli_run.check
-
-```{autodoc2-docstring} boardwalk.cli_run.check
-```
-````
-
-````{py:function} run_workflow(hosts: list[boardwalk.host.Host], inventory_vars: boardwalk.ansible.HostVarsType, workspace: boardwalk.manifest.Workspace, verbosity: int)
-:canonical: boardwalk.cli_run.run_workflow
-
-```{autodoc2-docstring} boardwalk.cli_run.run_workflow
-```
-````
-
-````{py:function} run_failure_mode_handler(exception: Exception, hostname: str, workspace: boardwalk.manifest.Workspace)
-:canonical: boardwalk.cli_run.run_failure_mode_handler
-
-```{autodoc2-docstring} boardwalk.cli_run.run_failure_mode_handler
-```
-````
-
-````{py:function} filter_hosts_by_limit(workspace: boardwalk.manifest.Workspace, hosts: collections.abc.ItemsView[str, boardwalk.host.Host], pattern: str) -> list[boardwalk.host.Host]
-:canonical: boardwalk.cli_run.filter_hosts_by_limit
-
-```{autodoc2-docstring} boardwalk.cli_run.filter_hosts_by_limit
-```
-````
-
-````{py:function} sort_host_list(hosts: list[boardwalk.host.Host], sort_method: str)
-:canonical: boardwalk.cli_run.sort_host_list
-
-```{autodoc2-docstring} boardwalk.cli_run.sort_host_list
-```
-````
-
-````{py:function} check_host_preconditions_locally(hosts: list[boardwalk.host.Host], inventory_vars: boardwalk.ansible.HostVarsType, workspace: boardwalk.manifest.Workspace) -> list[boardwalk.host.Host]
-:canonical: boardwalk.cli_run.check_host_preconditions_locally
-
-```{autodoc2-docstring} boardwalk.cli_run.check_host_preconditions_locally
-```
-````
-
-````{py:function} handle_workflow_catch(workspace: boardwalk.manifest.Workspace, hostname: str)
-:canonical: boardwalk.cli_run.handle_workflow_catch
-
-```{autodoc2-docstring} boardwalk.cli_run.handle_workflow_catch
-```
-````
-
-````{py:function} lock_remote_host(host: boardwalk.host.Host)
-:canonical: boardwalk.cli_run.lock_remote_host
-
-```{autodoc2-docstring} boardwalk.cli_run.lock_remote_host
-```
-````
-
-````{py:function} bootstrap_with_server(workspace: boardwalk.manifest.Workspace, ctx: click.Context)
-:canonical: boardwalk.cli_run.bootstrap_with_server
-
-```{autodoc2-docstring} boardwalk.cli_run.bootstrap_with_server
-```
-````
-
-````{py:function} update_host_facts_in_local_state(host: boardwalk.host.Host, workspace: boardwalk.manifest.Workspace)
-:canonical: boardwalk.cli_run.update_host_facts_in_local_state
-
-```{autodoc2-docstring} boardwalk.cli_run.update_host_facts_in_local_state
-```
-````
-
-````{py:function} directly_confirm_host_preconditions(host: boardwalk.host.Host, inventory_vars: boardwalk.ansible.InventoryHostVars, workspace: boardwalk.manifest.Workspace) -> bool
-:canonical: boardwalk.cli_run.directly_confirm_host_preconditions
-
-```{autodoc2-docstring} boardwalk.cli_run.directly_confirm_host_preconditions
-```
-````
-
-````{py:function} execute_workflow_jobs(host: boardwalk.host.Host, workspace: boardwalk.manifest.Workspace, job_kind: str, verbosity: int)
-:canonical: boardwalk.cli_run.execute_workflow_jobs
-
-```{autodoc2-docstring} boardwalk.cli_run.execute_workflow_jobs
-```
-````
-
-````{py:function} execute_host_workflow(host: boardwalk.host.Host, workspace: boardwalk.manifest.Workspace, verbosity: int)
-:canonical: boardwalk.cli_run.execute_host_workflow
-
-```{autodoc2-docstring} boardwalk.cli_run.execute_host_workflow
-```
-````
-
-````{py:exception} NoHostsMatched()
-:canonical: boardwalk.cli_run.NoHostsMatched
-
-Bases: {py:obj}`Exception`
-
-```{autodoc2-docstring} boardwalk.cli_run.NoHostsMatched
-```
-
-```{rubric} Initialization
-```
-
-```{autodoc2-docstring} boardwalk.cli_run.NoHostsMatched.__init__
-```
-
-````
-
-````{py:exception} HostPreConditionsUnmet()
-:canonical: boardwalk.cli_run.HostPreConditionsUnmet
-
-Bases: {py:obj}`Exception`
-
-```{autodoc2-docstring} boardwalk.cli_run.HostPreConditionsUnmet
-```
-
-```{rubric} Initialization
-```
-
-```{autodoc2-docstring} boardwalk.cli_run.HostPreConditionsUnmet.__init__
-```
-
-````
diff --git a/docs/source/apidocs/boardwalk/boardwalk.cli_workspace.md b/docs/source/apidocs/boardwalk/boardwalk.cli_workspace.md
deleted file mode 100644
index 0969251..0000000
--- a/docs/source/apidocs/boardwalk/boardwalk.cli_workspace.md
+++ /dev/null
@@ -1,97 +0,0 @@
-# {py:mod}`boardwalk.cli_workspace`
-
-```{py:module} boardwalk.cli_workspace
-```
-
-```{autodoc2-docstring} boardwalk.cli_workspace
-:allowtitles:
-```
-
-## Module Contents
-
-### Functions
-
-````{list-table}
-:class: autosummary longtable
-:align: left
-
-* - {py:obj}`workspace `
- - ```{autodoc2-docstring} boardwalk.cli_workspace.workspace
- :summary:
- ```
-* - {py:obj}`workspace_show `
- - ```{autodoc2-docstring} boardwalk.cli_workspace.workspace_show
- :summary:
- ```
-* - {py:obj}`workspace_use_completion `
- - ```{autodoc2-docstring} boardwalk.cli_workspace.workspace_use_completion
- :summary:
- ```
-* - {py:obj}`workspace_use `
- - ```{autodoc2-docstring} boardwalk.cli_workspace.workspace_use
- :summary:
- ```
-* - {py:obj}`workspace_list `
- - ```{autodoc2-docstring} boardwalk.cli_workspace.workspace_list
- :summary:
- ```
-* - {py:obj}`workspace_reset `
- - ```{autodoc2-docstring} boardwalk.cli_workspace.workspace_reset
- :summary:
- ```
-* - {py:obj}`workspace_dump `
- - ```{autodoc2-docstring} boardwalk.cli_workspace.workspace_dump
- :summary:
- ```
-````
-
-### API
-
-````{py:function} workspace()
-:canonical: boardwalk.cli_workspace.workspace
-
-```{autodoc2-docstring} boardwalk.cli_workspace.workspace
-```
-````
-
-````{py:function} workspace_show()
-:canonical: boardwalk.cli_workspace.workspace_show
-
-```{autodoc2-docstring} boardwalk.cli_workspace.workspace_show
-```
-````
-
-````{py:function} workspace_use_completion(ctx, param, incomplete)
-:canonical: boardwalk.cli_workspace.workspace_use_completion
-
-```{autodoc2-docstring} boardwalk.cli_workspace.workspace_use_completion
-```
-````
-
-````{py:function} workspace_use(workspace_name: str)
-:canonical: boardwalk.cli_workspace.workspace_use
-
-```{autodoc2-docstring} boardwalk.cli_workspace.workspace_use
-```
-````
-
-````{py:function} workspace_list()
-:canonical: boardwalk.cli_workspace.workspace_list
-
-```{autodoc2-docstring} boardwalk.cli_workspace.workspace_list
-```
-````
-
-````{py:function} workspace_reset()
-:canonical: boardwalk.cli_workspace.workspace_reset
-
-```{autodoc2-docstring} boardwalk.cli_workspace.workspace_reset
-```
-````
-
-````{py:function} workspace_dump()
-:canonical: boardwalk.cli_workspace.workspace_dump
-
-```{autodoc2-docstring} boardwalk.cli_workspace.workspace_dump
-```
-````
diff --git a/docs/source/apidocs/boardwalk/boardwalk.host.md b/docs/source/apidocs/boardwalk/boardwalk.host.md
deleted file mode 100644
index 1d72ed0..0000000
--- a/docs/source/apidocs/boardwalk/boardwalk.host.md
+++ /dev/null
@@ -1,211 +0,0 @@
-# {py:mod}`boardwalk.host`
-
-```{py:module} boardwalk.host
-```
-
-```{autodoc2-docstring} boardwalk.host
-:allowtitles:
-```
-
-## Module Contents
-
-### Classes
-
-````{list-table}
-:class: autosummary longtable
-:align: left
-
-* - {py:obj}`Host `
- - ```{autodoc2-docstring} boardwalk.host.Host
- :summary:
- ```
-````
-
-### API
-
-`````{py:class} Host(/, **data: typing.Any)
-:canonical: boardwalk.host.Host
-
-Bases: {py:obj}`pydantic.BaseModel`
-
-```{autodoc2-docstring} boardwalk.host.Host
-```
-
-```{rubric} Initialization
-```
-
-```{autodoc2-docstring} boardwalk.host.Host.__init__
-```
-
-````{py:attribute} ansible_facts
-:canonical: boardwalk.host.Host.ansible_facts
-:type: dict[str, typing.Any]
-:value: >
- None
-
-```{autodoc2-docstring} boardwalk.host.Host.ansible_facts
-```
-
-````
-
-````{py:attribute} name
-:canonical: boardwalk.host.Host.name
-:type: str
-:value: >
- None
-
-```{autodoc2-docstring} boardwalk.host.Host.name
-```
-
-````
-
-````{py:attribute} meta
-:canonical: boardwalk.host.Host.meta
-:type: dict[str, str | int | bool]
-:value: >
- None
-
-```{autodoc2-docstring} boardwalk.host.Host.meta
-```
-
-````
-
-````{py:attribute} remote_mutex_path
-:canonical: boardwalk.host.Host.remote_mutex_path
-:type: str
-:value: >
- '/opt/boardwalk.mutex'
-
-```{autodoc2-docstring} boardwalk.host.Host.remote_mutex_path
-```
-
-````
-
-````{py:attribute} remote_alert_msg
-:canonical: boardwalk.host.Host.remote_alert_msg
-:type: str
-:value: >
- 'ALERT: Boardwalk is running a workflow against this host. Services may be interrupted'
-
-```{autodoc2-docstring} boardwalk.host.Host.remote_alert_msg
-```
-
-````
-
-````{py:attribute} remote_alert_string_formatted
-:canonical: boardwalk.host.Host.remote_alert_string_formatted
-:type: str
-:value: >
- None
-
-```{autodoc2-docstring} boardwalk.host.Host.remote_alert_string_formatted
-```
-
-````
-
-````{py:attribute} remote_alert_motd
-:canonical: boardwalk.host.Host.remote_alert_motd
-:type: str
-:value: >
- None
-
-```{autodoc2-docstring} boardwalk.host.Host.remote_alert_motd
-```
-
-````
-
-````{py:attribute} remote_alert_motd_path
-:canonical: boardwalk.host.Host.remote_alert_motd_path
-:type: str
-:value: >
- '/etc/update-motd.d/99-boardwalk-alert'
-
-```{autodoc2-docstring} boardwalk.host.Host.remote_alert_motd_path
-```
-
-````
-
-````{py:attribute} remote_alert_wall_cmd
-:canonical: boardwalk.host.Host.remote_alert_wall_cmd
-:type: str
-:value: >
- None
-
-```{autodoc2-docstring} boardwalk.host.Host.remote_alert_wall_cmd
-```
-
-````
-
-````{py:method} ansible_run(invocation_msg: str, tasks: boardwalk.ansible.AnsibleTasksType, job_type: boardwalk.manifest.JobTypes, verbosity: int = 0, become: bool = False, become_password: str | None = None, check: bool = False, gather_facts: bool = True, quiet: bool = True, extra_vars: dict = {}) -> ansible_runner.Runner
-:canonical: boardwalk.host.Host.ansible_run
-
-```{autodoc2-docstring} boardwalk.host.Host.ansible_run
-```
-
-````
-
-````{py:method} is_locked() -> str | bool
-:canonical: boardwalk.host.Host.is_locked
-
-```{autodoc2-docstring} boardwalk.host.Host.is_locked
-```
-
-````
-
-````{py:method} lock(become_password: str | None = None, check: bool = False, stomp_existing_locks: bool = False)
-:canonical: boardwalk.host.Host.lock
-
-```{autodoc2-docstring} boardwalk.host.Host.lock
-```
-
-````
-
-````{py:method} release(become_password: str | None = None, check: bool = False) -> None
-:canonical: boardwalk.host.Host.release
-
-```{autodoc2-docstring} boardwalk.host.Host.release
-```
-
-````
-
-````{py:method} gather_facts() -> dict[str, typing.Any]
-:canonical: boardwalk.host.Host.gather_facts
-
-```{autodoc2-docstring} boardwalk.host.Host.gather_facts
-```
-
-````
-
-````{py:method} get_remote_state() -> boardwalk.state.RemoteStateModel
-:canonical: boardwalk.host.Host.get_remote_state
-
-```{autodoc2-docstring} boardwalk.host.Host.get_remote_state
-```
-
-````
-
-````{py:method} set_remote_state(remote_state_obj: boardwalk.state.RemoteStateModel, become_password: str | None = None, check: bool = False)
-:canonical: boardwalk.host.Host.set_remote_state
-
-```{autodoc2-docstring} boardwalk.host.Host.set_remote_state
-```
-
-````
-
-`````
-
-````{py:exception} RemoteHostLocked(message: str)
-:canonical: boardwalk.host.RemoteHostLocked
-
-Bases: {py:obj}`boardwalk.app_exceptions.BoardwalkException`
-
-```{autodoc2-docstring} boardwalk.host.RemoteHostLocked
-```
-
-```{rubric} Initialization
-```
-
-```{autodoc2-docstring} boardwalk.host.RemoteHostLocked.__init__
-```
-
-````
diff --git a/docs/source/apidocs/boardwalk/boardwalk.manifest.md b/docs/source/apidocs/boardwalk/boardwalk.manifest.md
deleted file mode 100644
index dc4f498..0000000
--- a/docs/source/apidocs/boardwalk/boardwalk.manifest.md
+++ /dev/null
@@ -1,610 +0,0 @@
-# {py:mod}`boardwalk.manifest`
-
-```{py:module} boardwalk.manifest
-```
-
-```{autodoc2-docstring} boardwalk.manifest
-:allowtitles:
-```
-
-## Module Contents
-
-### Classes
-
-````{list-table}
-:class: autosummary longtable
-:align: left
-
-* - {py:obj}`JobTypes `
- -
-* - {py:obj}`BaseJob `
- - ```{autodoc2-docstring} boardwalk.manifest.BaseJob
- :summary:
- ```
-* - {py:obj}`TaskJob `
- - ```{autodoc2-docstring} boardwalk.manifest.TaskJob
- :summary:
- ```
-* - {py:obj}`Job `
- - ```{autodoc2-docstring} boardwalk.manifest.Job
- :summary:
- ```
-* - {py:obj}`PlaybookJob `
- - ```{autodoc2-docstring} boardwalk.manifest.PlaybookJob
- :summary:
- ```
-* - {py:obj}`WorkflowConfig `
- - ```{autodoc2-docstring} boardwalk.manifest.WorkflowConfig
- :summary:
- ```
-* - {py:obj}`Workflow `
- - ```{autodoc2-docstring} boardwalk.manifest.Workflow
- :summary:
- ```
-* - {py:obj}`WorkspaceConfig `
- - ```{autodoc2-docstring} boardwalk.manifest.WorkspaceConfig
- :summary:
- ```
-* - {py:obj}`Workspace `
- - ```{autodoc2-docstring} boardwalk.manifest.Workspace
- :summary:
- ```
-````
-
-### Functions
-
-````{list-table}
-:class: autosummary longtable
-:align: left
-
-* - {py:obj}`get_ws `
- - ```{autodoc2-docstring} boardwalk.manifest.get_ws
- :summary:
- ```
-* - {py:obj}`get_boardwalkd_url `
- - ```{autodoc2-docstring} boardwalk.manifest.get_boardwalkd_url
- :summary:
- ```
-* - {py:obj}`path `
- - ```{autodoc2-docstring} boardwalk.manifest.path
- :summary:
- ```
-````
-
-### Data
-
-````{list-table}
-:class: autosummary longtable
-:align: left
-
-* - {py:obj}`workspaces_dir `
- - ```{autodoc2-docstring} boardwalk.manifest.workspaces_dir
- :summary:
- ```
-* - {py:obj}`active_workspace_file `
- - ```{autodoc2-docstring} boardwalk.manifest.active_workspace_file
- :summary:
- ```
-````
-
-### API
-
-````{py:data} workspaces_dir
-:canonical: boardwalk.manifest.workspaces_dir
-:value: >
- 'joinpath(...)'
-
-```{autodoc2-docstring} boardwalk.manifest.workspaces_dir
-```
-
-````
-
-````{py:data} active_workspace_file
-:canonical: boardwalk.manifest.active_workspace_file
-:value: >
- 'joinpath(...)'
-
-```{autodoc2-docstring} boardwalk.manifest.active_workspace_file
-```
-
-````
-
-````{py:exception} DuplicateManifestClass()
-:canonical: boardwalk.manifest.DuplicateManifestClass
-
-Bases: {py:obj}`Exception`
-
-```{autodoc2-docstring} boardwalk.manifest.DuplicateManifestClass
-```
-
-```{rubric} Initialization
-```
-
-```{autodoc2-docstring} boardwalk.manifest.DuplicateManifestClass.__init__
-```
-
-````
-
-````{py:exception} ManifestNotFound()
-:canonical: boardwalk.manifest.ManifestNotFound
-
-Bases: {py:obj}`Exception`
-
-```{autodoc2-docstring} boardwalk.manifest.ManifestNotFound
-```
-
-```{rubric} Initialization
-```
-
-```{autodoc2-docstring} boardwalk.manifest.ManifestNotFound.__init__
-```
-
-````
-
-`````{py:exception} NoActiveWorkspace()
-:canonical: boardwalk.manifest.NoActiveWorkspace
-
-Bases: {py:obj}`Exception`
-
-```{autodoc2-docstring} boardwalk.manifest.NoActiveWorkspace
-```
-
-```{rubric} Initialization
-```
-
-```{autodoc2-docstring} boardwalk.manifest.NoActiveWorkspace.__init__
-```
-
-````{py:attribute} message
-:canonical: boardwalk.manifest.NoActiveWorkspace.message
-:value: >
- 'No workspace selected. Use `boardwalk workspace list` to list workspaces and `boardwalk workspace us...'
-
-```{autodoc2-docstring} boardwalk.manifest.NoActiveWorkspace.message
-```
-
-````
-
-`````
-
-````{py:exception} WorkspaceNotFound()
-:canonical: boardwalk.manifest.WorkspaceNotFound
-
-Bases: {py:obj}`Exception`
-
-```{autodoc2-docstring} boardwalk.manifest.WorkspaceNotFound
-```
-
-```{rubric} Initialization
-```
-
-```{autodoc2-docstring} boardwalk.manifest.WorkspaceNotFound.__init__
-```
-
-````
-
-````{py:function} get_ws() -> Workspace
-:canonical: boardwalk.manifest.get_ws
-
-```{autodoc2-docstring} boardwalk.manifest.get_ws
-```
-````
-
-````{py:function} get_boardwalkd_url() -> str
-:canonical: boardwalk.manifest.get_boardwalkd_url
-
-```{autodoc2-docstring} boardwalk.manifest.get_boardwalkd_url
-```
-````
-
-`````{py:class} JobTypes(*args, **kwds)
-:canonical: boardwalk.manifest.JobTypes
-
-Bases: {py:obj}`enum.Enum`
-
-````{py:attribute} TASK
-:canonical: boardwalk.manifest.JobTypes.TASK
-:value: >
- 1
-
-```{autodoc2-docstring} boardwalk.manifest.JobTypes.TASK
-```
-
-````
-
-````{py:attribute} PLAYBOOK
-:canonical: boardwalk.manifest.JobTypes.PLAYBOOK
-:value: >
- 2
-
-```{autodoc2-docstring} boardwalk.manifest.JobTypes.PLAYBOOK
-```
-
-````
-
-`````
-
-`````{py:class} BaseJob(options: dict[str, typing.Any] = dict())
-:canonical: boardwalk.manifest.BaseJob
-
-```{autodoc2-docstring} boardwalk.manifest.BaseJob
-```
-
-```{rubric} Initialization
-```
-
-```{autodoc2-docstring} boardwalk.manifest.BaseJob.__init__
-```
-
-````{py:attribute} options
-:canonical: boardwalk.manifest.BaseJob.options
-:value: >
- None
-
-```{autodoc2-docstring} boardwalk.manifest.BaseJob.options
-```
-
-````
-
-````{py:method} required_options() -> tuple[str]
-:canonical: boardwalk.manifest.BaseJob.required_options
-
-```{autodoc2-docstring} boardwalk.manifest.BaseJob.required_options
-```
-
-````
-
-````{py:method} preconditions(facts: boardwalk.ansible.AnsibleFacts, inventory_vars: boardwalk.ansible.InventoryHostVars) -> bool
-:canonical: boardwalk.manifest.BaseJob.preconditions
-
-```{autodoc2-docstring} boardwalk.manifest.BaseJob.preconditions
-```
-
-````
-
-````{py:method} _required_options() -> tuple[str]
-:canonical: boardwalk.manifest.BaseJob._required_options
-
-```{autodoc2-docstring} boardwalk.manifest.BaseJob._required_options
-```
-
-````
-
-````{py:method} _check_options(options: dict[str, typing.Any])
-:canonical: boardwalk.manifest.BaseJob._check_options
-
-```{autodoc2-docstring} boardwalk.manifest.BaseJob._check_options
-```
-
-````
-
-`````
-
-`````{py:class} TaskJob(options: dict[str, typing.Any] = dict())
-:canonical: boardwalk.manifest.TaskJob
-
-Bases: {py:obj}`boardwalk.manifest.BaseJob`
-
-```{autodoc2-docstring} boardwalk.manifest.TaskJob
-```
-
-```{rubric} Initialization
-```
-
-```{autodoc2-docstring} boardwalk.manifest.TaskJob.__init__
-```
-
-````{py:method} tasks() -> boardwalk.ansible.AnsibleTasksType
-:canonical: boardwalk.manifest.TaskJob.tasks
-
-```{autodoc2-docstring} boardwalk.manifest.TaskJob.tasks
-```
-
-````
-
-`````
-
-````{py:class} Job(options: dict[str, typing.Any] = dict())
-:canonical: boardwalk.manifest.Job
-
-Bases: {py:obj}`boardwalk.manifest.TaskJob`
-
-```{autodoc2-docstring} boardwalk.manifest.Job
-```
-
-```{rubric} Initialization
-```
-
-```{autodoc2-docstring} boardwalk.manifest.Job.__init__
-```
-
-````
-
-`````{py:class} PlaybookJob(options: dict[str, typing.Any] = dict())
-:canonical: boardwalk.manifest.PlaybookJob
-
-Bases: {py:obj}`boardwalk.manifest.BaseJob`
-
-```{autodoc2-docstring} boardwalk.manifest.PlaybookJob
-```
-
-```{rubric} Initialization
-```
-
-```{autodoc2-docstring} boardwalk.manifest.PlaybookJob.__init__
-```
-
-````{py:method} tasks() -> boardwalk.ansible.AnsibleTasksType
-:canonical: boardwalk.manifest.PlaybookJob.tasks
-
-```{autodoc2-docstring} boardwalk.manifest.PlaybookJob.tasks
-```
-
-````
-
-````{py:method} playbooks() -> boardwalk.ansible.AnsibleTasksType
-:canonical: boardwalk.manifest.PlaybookJob.playbooks
-
-```{autodoc2-docstring} boardwalk.manifest.PlaybookJob.playbooks
-```
-
-````
-
-`````
-
-````{py:class} WorkflowConfig(always_retry_failed_hosts: bool = True)
-:canonical: boardwalk.manifest.WorkflowConfig
-
-```{autodoc2-docstring} boardwalk.manifest.WorkflowConfig
-```
-
-```{rubric} Initialization
-```
-
-```{autodoc2-docstring} boardwalk.manifest.WorkflowConfig.__init__
-```
-
-````
-
-`````{py:class} Workflow()
-:canonical: boardwalk.manifest.Workflow
-
-Bases: {py:obj}`abc.ABC`
-
-```{autodoc2-docstring} boardwalk.manifest.Workflow
-```
-
-```{rubric} Initialization
-```
-
-```{autodoc2-docstring} boardwalk.manifest.Workflow.__init__
-```
-
-````{py:method} config() -> boardwalk.manifest.WorkflowConfig
-:canonical: boardwalk.manifest.Workflow.config
-
-```{autodoc2-docstring} boardwalk.manifest.Workflow.config
-```
-
-````
-
-````{py:method} jobs()
-:canonical: boardwalk.manifest.Workflow.jobs
-:abstractmethod:
-
-```{autodoc2-docstring} boardwalk.manifest.Workflow.jobs
-```
-
-````
-
-````{py:method} exit_jobs() -> boardwalk.manifest.TaskJob | boardwalk.manifest.PlaybookJob | tuple[boardwalk.manifest.TaskJob | boardwalk.manifest.PlaybookJob, ...]
-:canonical: boardwalk.manifest.Workflow.exit_jobs
-
-```{autodoc2-docstring} boardwalk.manifest.Workflow.exit_jobs
-```
-
-````
-
-`````
-
-`````{py:class} WorkspaceConfig(host_pattern: str, workflow: boardwalk.manifest.Workflow, default_sort_order: str = 'shuffle', require_limit: bool = False)
-:canonical: boardwalk.manifest.WorkspaceConfig
-
-```{autodoc2-docstring} boardwalk.manifest.WorkspaceConfig
-```
-
-```{rubric} Initialization
-```
-
-```{autodoc2-docstring} boardwalk.manifest.WorkspaceConfig.__init__
-```
-
-````{py:attribute} valid_sort_orders
-:canonical: boardwalk.manifest.WorkspaceConfig.valid_sort_orders
-:value: >
- ['ascending', 'descending', 'shuffle']
-
-```{autodoc2-docstring} boardwalk.manifest.WorkspaceConfig.valid_sort_orders
-```
-
-````
-
-````{py:property} default_sort_order
-:canonical: boardwalk.manifest.WorkspaceConfig.default_sort_order
-:type: str
-
-```{autodoc2-docstring} boardwalk.manifest.WorkspaceConfig.default_sort_order
-```
-
-````
-
-````{py:method} _is_valid_sort_order(value: str)
-:canonical: boardwalk.manifest.WorkspaceConfig._is_valid_sort_order
-
-```{autodoc2-docstring} boardwalk.manifest.WorkspaceConfig._is_valid_sort_order
-```
-
-````
-
-`````
-
-`````{py:class} Workspace()
-:canonical: boardwalk.manifest.Workspace
-
-Bases: {py:obj}`abc.ABC`
-
-```{autodoc2-docstring} boardwalk.manifest.Workspace
-```
-
-```{rubric} Initialization
-```
-
-```{autodoc2-docstring} boardwalk.manifest.Workspace.__init__
-```
-
-````{py:attribute} _initialized
-:canonical: boardwalk.manifest.Workspace._initialized
-:type: bool
-:value: >
- False
-
-```{autodoc2-docstring} boardwalk.manifest.Workspace._initialized
-```
-
-````
-
-````{py:attribute} _instance
-:canonical: boardwalk.manifest.Workspace._instance
-:type: boardwalk.manifest.Workspace | None
-:value: >
- None
-
-```{autodoc2-docstring} boardwalk.manifest.Workspace._instance
-```
-
-````
-
-````{py:method} __new__()
-:canonical: boardwalk.manifest.Workspace.__new__
-
-```{autodoc2-docstring} boardwalk.manifest.Workspace.__new__
-```
-
-````
-
-````{py:method} assert_host_pattern_unchanged() -> None
-:canonical: boardwalk.manifest.Workspace.assert_host_pattern_unchanged
-
-```{autodoc2-docstring} boardwalk.manifest.Workspace.assert_host_pattern_unchanged
-```
-
-````
-
-````{py:method} config() -> boardwalk.manifest.WorkspaceConfig
-:canonical: boardwalk.manifest.Workspace.config
-:abstractmethod:
-
-```{autodoc2-docstring} boardwalk.manifest.Workspace.config
-```
-
-````
-
-````{py:method} flush()
-:canonical: boardwalk.manifest.Workspace.flush
-
-```{autodoc2-docstring} boardwalk.manifest.Workspace.flush
-```
-
-````
-
-````{py:method} reset()
-:canonical: boardwalk.manifest.Workspace.reset
-
-```{autodoc2-docstring} boardwalk.manifest.Workspace.reset
-```
-
-````
-
-````{py:method} mutex()
-:canonical: boardwalk.manifest.Workspace.mutex
-
-```{autodoc2-docstring} boardwalk.manifest.Workspace.mutex
-```
-
-````
-
-````{py:method} has_mutex()
-:canonical: boardwalk.manifest.Workspace.has_mutex
-
-```{autodoc2-docstring} boardwalk.manifest.Workspace.has_mutex
-```
-
-````
-
-````{py:method} unmutex()
-:canonical: boardwalk.manifest.Workspace.unmutex
-
-```{autodoc2-docstring} boardwalk.manifest.Workspace.unmutex
-```
-
-````
-
-````{py:method} catch()
-:canonical: boardwalk.manifest.Workspace.catch
-
-```{autodoc2-docstring} boardwalk.manifest.Workspace.catch
-```
-
-````
-
-````{py:method} caught()
-:canonical: boardwalk.manifest.Workspace.caught
-
-```{autodoc2-docstring} boardwalk.manifest.Workspace.caught
-```
-
-````
-
-````{py:method} release()
-:canonical: boardwalk.manifest.Workspace.release
-
-```{autodoc2-docstring} boardwalk.manifest.Workspace.release
-```
-
-````
-
-````{py:method} use(name: str)
-:canonical: boardwalk.manifest.Workspace.use
-:staticmethod:
-
-```{autodoc2-docstring} boardwalk.manifest.Workspace.use
-```
-
-````
-
-````{py:method} exists(name: str) -> bool
-:canonical: boardwalk.manifest.Workspace.exists
-:staticmethod:
-
-```{autodoc2-docstring} boardwalk.manifest.Workspace.exists
-```
-
-````
-
-````{py:method} fetch_subclass(name: str) -> collections.abc.Callable[..., boardwalk.manifest.Workspace]
-:canonical: boardwalk.manifest.Workspace.fetch_subclass
-:staticmethod:
-
-```{autodoc2-docstring} boardwalk.manifest.Workspace.fetch_subclass
-```
-
-````
-
-`````
-
-````{py:function} path(file_path: str) -> str
-:canonical: boardwalk.manifest.path
-
-```{autodoc2-docstring} boardwalk.manifest.path
-```
-````
diff --git a/docs/source/apidocs/boardwalk/boardwalk.md b/docs/source/apidocs/boardwalk/boardwalk.md
deleted file mode 100644
index 2fc7be8..0000000
--- a/docs/source/apidocs/boardwalk/boardwalk.md
+++ /dev/null
@@ -1,29 +0,0 @@
-# {py:mod}`boardwalk`
-
-```{py:module} boardwalk
-```
-
-```{autodoc2-docstring} boardwalk
-:allowtitles:
-```
-
-## Submodules
-
-```{toctree}
-:titlesonly:
-:maxdepth: 1
-
-boardwalk.ansible
-boardwalk.manifest
-boardwalk.cli_login
-boardwalk.cli_catch
-boardwalk.host
-boardwalk.app_exceptions
-boardwalk.cli_init
-boardwalk.cli_run
-boardwalk.cli
-boardwalk.utils
-boardwalk.cli_workspace
-boardwalk.__main__
-boardwalk.state
-```
diff --git a/docs/source/apidocs/boardwalk/boardwalk.state.md b/docs/source/apidocs/boardwalk/boardwalk.state.md
deleted file mode 100644
index 5a6eaef..0000000
--- a/docs/source/apidocs/boardwalk/boardwalk.state.md
+++ /dev/null
@@ -1,186 +0,0 @@
-# {py:mod}`boardwalk.state`
-
-```{py:module} boardwalk.state
-```
-
-```{autodoc2-docstring} boardwalk.state
-:allowtitles:
-```
-
-## Module Contents
-
-### Classes
-
-````{list-table}
-:class: autosummary longtable
-:align: left
-
-* - {py:obj}`StateBaseModel `
- - ```{autodoc2-docstring} boardwalk.state.StateBaseModel
- :summary:
- ```
-* - {py:obj}`LocalState `
- - ```{autodoc2-docstring} boardwalk.state.LocalState
- :summary:
- ```
-* - {py:obj}`RemoteStateWorkflow `
- - ```{autodoc2-docstring} boardwalk.state.RemoteStateWorkflow
- :summary:
- ```
-* - {py:obj}`RemoteStateWorkspace `
- - ```{autodoc2-docstring} boardwalk.state.RemoteStateWorkspace
- :summary:
- ```
-* - {py:obj}`RemoteStateModel `
- - ```{autodoc2-docstring} boardwalk.state.RemoteStateModel
- :summary:
- ```
-````
-
-### API
-
-````{py:class} StateBaseModel(/, **data: typing.Any)
-:canonical: boardwalk.state.StateBaseModel
-
-Bases: {py:obj}`pydantic.BaseModel`
-
-```{autodoc2-docstring} boardwalk.state.StateBaseModel
-```
-
-```{rubric} Initialization
-```
-
-```{autodoc2-docstring} boardwalk.state.StateBaseModel.__init__
-```
-
-````
-
-`````{py:class} LocalState(/, **data: typing.Any)
-:canonical: boardwalk.state.LocalState
-
-Bases: {py:obj}`boardwalk.state.StateBaseModel`
-
-```{autodoc2-docstring} boardwalk.state.LocalState
-```
-
-```{rubric} Initialization
-```
-
-```{autodoc2-docstring} boardwalk.state.LocalState.__init__
-```
-
-````{py:attribute} host_pattern
-:canonical: boardwalk.state.LocalState.host_pattern
-:type: str
-:value: >
- None
-
-```{autodoc2-docstring} boardwalk.state.LocalState.host_pattern
-```
-
-````
-
-````{py:attribute} hosts
-:canonical: boardwalk.state.LocalState.hosts
-:type: dict[str, boardwalk.host.Host]
-:value: >
- None
-
-```{autodoc2-docstring} boardwalk.state.LocalState.hosts
-```
-
-````
-
-`````
-
-`````{py:class} RemoteStateWorkflow(/, **data: typing.Any)
-:canonical: boardwalk.state.RemoteStateWorkflow
-
-Bases: {py:obj}`boardwalk.state.StateBaseModel`
-
-```{autodoc2-docstring} boardwalk.state.RemoteStateWorkflow
-```
-
-```{rubric} Initialization
-```
-
-```{autodoc2-docstring} boardwalk.state.RemoteStateWorkflow.__init__
-```
-
-````{py:attribute} started
-:canonical: boardwalk.state.RemoteStateWorkflow.started
-:type: bool
-:value: >
- False
-
-```{autodoc2-docstring} boardwalk.state.RemoteStateWorkflow.started
-```
-
-````
-
-````{py:attribute} succeeded
-:canonical: boardwalk.state.RemoteStateWorkflow.succeeded
-:type: bool
-:value: >
- False
-
-```{autodoc2-docstring} boardwalk.state.RemoteStateWorkflow.succeeded
-```
-
-````
-
-`````
-
-`````{py:class} RemoteStateWorkspace(/, **data: typing.Any)
-:canonical: boardwalk.state.RemoteStateWorkspace
-
-Bases: {py:obj}`boardwalk.state.StateBaseModel`
-
-```{autodoc2-docstring} boardwalk.state.RemoteStateWorkspace
-```
-
-```{rubric} Initialization
-```
-
-```{autodoc2-docstring} boardwalk.state.RemoteStateWorkspace.__init__
-```
-
-````{py:attribute} workflow
-:canonical: boardwalk.state.RemoteStateWorkspace.workflow
-:type: boardwalk.state.RemoteStateWorkflow
-:value: >
- None
-
-```{autodoc2-docstring} boardwalk.state.RemoteStateWorkspace.workflow
-```
-
-````
-
-`````
-
-`````{py:class} RemoteStateModel(/, **data: typing.Any)
-:canonical: boardwalk.state.RemoteStateModel
-
-Bases: {py:obj}`boardwalk.state.StateBaseModel`
-
-```{autodoc2-docstring} boardwalk.state.RemoteStateModel
-```
-
-```{rubric} Initialization
-```
-
-```{autodoc2-docstring} boardwalk.state.RemoteStateModel.__init__
-```
-
-````{py:attribute} workspaces
-:canonical: boardwalk.state.RemoteStateModel.workspaces
-:type: dict[str, boardwalk.state.RemoteStateWorkspace]
-:value: >
- None
-
-```{autodoc2-docstring} boardwalk.state.RemoteStateModel.workspaces
-```
-
-````
-
-`````
diff --git a/docs/source/apidocs/boardwalk/boardwalk.utils.md b/docs/source/apidocs/boardwalk/boardwalk.utils.md
deleted file mode 100644
index d4951e3..0000000
--- a/docs/source/apidocs/boardwalk/boardwalk.utils.md
+++ /dev/null
@@ -1,31 +0,0 @@
-# {py:mod}`boardwalk.utils`
-
-```{py:module} boardwalk.utils
-```
-
-```{autodoc2-docstring} boardwalk.utils
-:allowtitles:
-```
-
-## Module Contents
-
-### Functions
-
-````{list-table}
-:class: autosummary longtable
-:align: left
-
-* - {py:obj}`strtobool `
- - ```{autodoc2-docstring} boardwalk.utils.strtobool
- :summary:
- ```
-````
-
-### API
-
-````{py:function} strtobool(val: str) -> bool
-:canonical: boardwalk.utils.strtobool
-
-```{autodoc2-docstring} boardwalk.utils.strtobool
-```
-````
diff --git a/docs/source/apidocs/boardwalkd/boardwalkd.__main__.md b/docs/source/apidocs/boardwalkd/boardwalkd.__main__.md
deleted file mode 100644
index ea70e29..0000000
--- a/docs/source/apidocs/boardwalkd/boardwalkd.__main__.md
+++ /dev/null
@@ -1,8 +0,0 @@
-# {py:mod}`boardwalkd.__main__`
-
-```{py:module} boardwalkd.__main__
-```
-
-```{autodoc2-docstring} boardwalkd.__main__
-:allowtitles:
-```
diff --git a/docs/source/apidocs/boardwalkd/boardwalkd.broadcast.md b/docs/source/apidocs/boardwalkd/boardwalkd.broadcast.md
deleted file mode 100644
index f20c618..0000000
--- a/docs/source/apidocs/boardwalkd/boardwalkd.broadcast.md
+++ /dev/null
@@ -1,32 +0,0 @@
-# {py:mod}`boardwalkd.broadcast`
-
-```{py:module} boardwalkd.broadcast
-```
-
-```{autodoc2-docstring} boardwalkd.broadcast
-:allowtitles:
-```
-
-## Module Contents
-
-### Functions
-
-````{list-table}
-:class: autosummary longtable
-:align: left
-
-* - {py:obj}`handle_slack_broadcast `
- - ```{autodoc2-docstring} boardwalkd.broadcast.handle_slack_broadcast
- :summary:
- ```
-````
-
-### API
-
-````{py:function} handle_slack_broadcast(event: boardwalkd.protocol.WorkspaceEvent, workspace: str, webhook_url: str | None, error_webhook_url: str | None, server_url: str)
-:canonical: boardwalkd.broadcast.handle_slack_broadcast
-:async:
-
-```{autodoc2-docstring} boardwalkd.broadcast.handle_slack_broadcast
-```
-````
diff --git a/docs/source/apidocs/boardwalkd/boardwalkd.cli.md b/docs/source/apidocs/boardwalkd/boardwalkd.cli.md
deleted file mode 100644
index 7b7aa96..0000000
--- a/docs/source/apidocs/boardwalkd/boardwalkd.cli.md
+++ /dev/null
@@ -1,76 +0,0 @@
-# {py:mod}`boardwalkd.cli`
-
-```{py:module} boardwalkd.cli
-```
-
-```{autodoc2-docstring} boardwalkd.cli
-:allowtitles:
-```
-
-## Module Contents
-
-### Functions
-
-````{list-table}
-:class: autosummary longtable
-:align: left
-
-* - {py:obj}`cli `
- - ```{autodoc2-docstring} boardwalkd.cli.cli
- :summary:
- ```
-* - {py:obj}`serve `
- - ```{autodoc2-docstring} boardwalkd.cli.serve
- :summary:
- ```
-* - {py:obj}`version `
- - ```{autodoc2-docstring} boardwalkd.cli.version
- :summary:
- ```
-````
-
-### Data
-
-````{list-table}
-:class: autosummary longtable
-:align: left
-
-* - {py:obj}`CONTEXT_SETTINGS `
- - ```{autodoc2-docstring} boardwalkd.cli.CONTEXT_SETTINGS
- :summary:
- ```
-````
-
-### API
-
-````{py:data} CONTEXT_SETTINGS
-:canonical: boardwalkd.cli.CONTEXT_SETTINGS
-:type: dict
-:value: >
- 'dict(...)'
-
-```{autodoc2-docstring} boardwalkd.cli.CONTEXT_SETTINGS
-```
-
-````
-
-````{py:function} cli()
-:canonical: boardwalkd.cli.cli
-
-```{autodoc2-docstring} boardwalkd.cli.cli
-```
-````
-
-````{py:function} serve(auth_expire_days: float, auth_method: str, develop: bool, host_header_pattern: str, owner: str | None, port: int | None, slack_error_webhook_url: str, slack_webhook_url: str, slack_app_token: str | None, slack_bot_token: str | None, slack_slash_command_prefix: str, tls_crt: str | None, tls_key: str | None, tls_port: int | None, url: str)
-:canonical: boardwalkd.cli.serve
-
-```{autodoc2-docstring} boardwalkd.cli.serve
-```
-````
-
-````{py:function} version()
-:canonical: boardwalkd.cli.version
-
-```{autodoc2-docstring} boardwalkd.cli.version
-```
-````
diff --git a/docs/source/apidocs/boardwalkd/boardwalkd.md b/docs/source/apidocs/boardwalkd/boardwalkd.md
deleted file mode 100644
index f1847e5..0000000
--- a/docs/source/apidocs/boardwalkd/boardwalkd.md
+++ /dev/null
@@ -1,23 +0,0 @@
-# {py:mod}`boardwalkd`
-
-```{py:module} boardwalkd
-```
-
-```{autodoc2-docstring} boardwalkd
-:allowtitles:
-```
-
-## Submodules
-
-```{toctree}
-:titlesonly:
-:maxdepth: 1
-
-boardwalkd.server
-boardwalkd.protocol
-boardwalkd.cli
-boardwalkd.broadcast
-boardwalkd.__main__
-boardwalkd.slack
-boardwalkd.state
-```
diff --git a/docs/source/apidocs/boardwalkd/boardwalkd.protocol.md b/docs/source/apidocs/boardwalkd/boardwalkd.protocol.md
deleted file mode 100644
index 1f1babe..0000000
--- a/docs/source/apidocs/boardwalkd/boardwalkd.protocol.md
+++ /dev/null
@@ -1,554 +0,0 @@
-# {py:mod}`boardwalkd.protocol`
-
-```{py:module} boardwalkd.protocol
-```
-
-```{autodoc2-docstring} boardwalkd.protocol
-:allowtitles:
-```
-
-## Module Contents
-
-### Classes
-
-````{list-table}
-:class: autosummary longtable
-:align: left
-
-* - {py:obj}`ProtocolBaseModel `
- - ```{autodoc2-docstring} boardwalkd.protocol.ProtocolBaseModel
- :summary:
- ```
-* - {py:obj}`ApiLoginMessage `
- - ```{autodoc2-docstring} boardwalkd.protocol.ApiLoginMessage
- :summary:
- ```
-* - {py:obj}`WorkspaceDetails `
- - ```{autodoc2-docstring} boardwalkd.protocol.WorkspaceDetails
- :summary:
- ```
-* - {py:obj}`WorkspaceEvent `
- - ```{autodoc2-docstring} boardwalkd.protocol.WorkspaceEvent
- :summary:
- ```
-* - {py:obj}`WorkspaceSemaphores `
- - ```{autodoc2-docstring} boardwalkd.protocol.WorkspaceSemaphores
- :summary:
- ```
-* - {py:obj}`Client `
- - ```{autodoc2-docstring} boardwalkd.protocol.Client
- :summary:
- ```
-* - {py:obj}`WorkspaceClient `
- - ```{autodoc2-docstring} boardwalkd.protocol.WorkspaceClient
- :summary:
- ```
-````
-
-### API
-
-````{py:class} ProtocolBaseModel(/, **data: typing.Any)
-:canonical: boardwalkd.protocol.ProtocolBaseModel
-
-Bases: {py:obj}`pydantic.BaseModel`
-
-```{autodoc2-docstring} boardwalkd.protocol.ProtocolBaseModel
-```
-
-```{rubric} Initialization
-```
-
-```{autodoc2-docstring} boardwalkd.protocol.ProtocolBaseModel.__init__
-```
-
-````
-
-`````{py:class} ApiLoginMessage(/, **data: typing.Any)
-:canonical: boardwalkd.protocol.ApiLoginMessage
-
-Bases: {py:obj}`boardwalkd.protocol.ProtocolBaseModel`
-
-```{autodoc2-docstring} boardwalkd.protocol.ApiLoginMessage
-```
-
-```{rubric} Initialization
-```
-
-```{autodoc2-docstring} boardwalkd.protocol.ApiLoginMessage.__init__
-```
-
-````{py:attribute} login_url
-:canonical: boardwalkd.protocol.ApiLoginMessage.login_url
-:type: str
-:value:
-
-```{autodoc2-docstring} boardwalkd.protocol.ApiLoginMessage.login_url
-```
-
-````
-
-````{py:attribute} token
-:canonical: boardwalkd.protocol.ApiLoginMessage.token
-:type: str
-:value:
-
-```{autodoc2-docstring} boardwalkd.protocol.ApiLoginMessage.token
-```
-
-````
-
-`````
-
-`````{py:class} WorkspaceDetails(/, **data: typing.Any)
-:canonical: boardwalkd.protocol.WorkspaceDetails
-
-Bases: {py:obj}`boardwalkd.protocol.ProtocolBaseModel`
-
-```{autodoc2-docstring} boardwalkd.protocol.WorkspaceDetails
-```
-
-```{rubric} Initialization
-```
-
-```{autodoc2-docstring} boardwalkd.protocol.WorkspaceDetails.__init__
-```
-
-````{py:attribute} host_pattern
-:canonical: boardwalkd.protocol.WorkspaceDetails.host_pattern
-:type: str
-:value:
-
-```{autodoc2-docstring} boardwalkd.protocol.WorkspaceDetails.host_pattern
-```
-
-````
-
-````{py:attribute} workflow
-:canonical: boardwalkd.protocol.WorkspaceDetails.workflow
-:type: str
-:value:
-
-```{autodoc2-docstring} boardwalkd.protocol.WorkspaceDetails.workflow
-```
-
-````
-
-````{py:attribute} worker_command
-:canonical: boardwalkd.protocol.WorkspaceDetails.worker_command
-:type: str
-:value:
-
-```{autodoc2-docstring} boardwalkd.protocol.WorkspaceDetails.worker_command
-```
-
-````
-
-````{py:attribute} worker_hostname
-:canonical: boardwalkd.protocol.WorkspaceDetails.worker_hostname
-:type: str
-:value:
-
-```{autodoc2-docstring} boardwalkd.protocol.WorkspaceDetails.worker_hostname
-```
-
-````
-
-````{py:attribute} worker_limit
-:canonical: boardwalkd.protocol.WorkspaceDetails.worker_limit
-:type: str
-:value:
-
-```{autodoc2-docstring} boardwalkd.protocol.WorkspaceDetails.worker_limit
-```
-
-````
-
-````{py:attribute} worker_username
-:canonical: boardwalkd.protocol.WorkspaceDetails.worker_username
-:type: str
-:value:
-
-```{autodoc2-docstring} boardwalkd.protocol.WorkspaceDetails.worker_username
-```
-
-````
-
-`````
-
-`````{py:class} WorkspaceEvent(**kwargs: str)
-:canonical: boardwalkd.protocol.WorkspaceEvent
-
-Bases: {py:obj}`boardwalkd.protocol.ProtocolBaseModel`
-
-```{autodoc2-docstring} boardwalkd.protocol.WorkspaceEvent
-```
-
-```{rubric} Initialization
-```
-
-```{autodoc2-docstring} boardwalkd.protocol.WorkspaceEvent.__init__
-```
-
-````{py:attribute} message
-:canonical: boardwalkd.protocol.WorkspaceEvent.message
-:type: str
-:value: >
- None
-
-```{autodoc2-docstring} boardwalkd.protocol.WorkspaceEvent.message
-```
-
-````
-
-````{py:attribute} severity
-:canonical: boardwalkd.protocol.WorkspaceEvent.severity
-:type: str
-:value: >
- None
-
-```{autodoc2-docstring} boardwalkd.protocol.WorkspaceEvent.severity
-```
-
-````
-
-````{py:attribute} create_time
-:canonical: boardwalkd.protocol.WorkspaceEvent.create_time
-:type: datetime.datetime | None
-:value: >
- None
-
-```{autodoc2-docstring} boardwalkd.protocol.WorkspaceEvent.create_time
-```
-
-````
-
-````{py:attribute} received_time
-:canonical: boardwalkd.protocol.WorkspaceEvent.received_time
-:type: datetime.datetime | None
-:value: >
- None
-
-```{autodoc2-docstring} boardwalkd.protocol.WorkspaceEvent.received_time
-```
-
-````
-
-````{py:method} severity_level(v: str)
-:canonical: boardwalkd.protocol.WorkspaceEvent.severity_level
-:classmethod:
-
-```{autodoc2-docstring} boardwalkd.protocol.WorkspaceEvent.severity_level
-```
-
-````
-
-`````
-
-`````{py:class} WorkspaceSemaphores(/, **data: typing.Any)
-:canonical: boardwalkd.protocol.WorkspaceSemaphores
-
-Bases: {py:obj}`boardwalkd.protocol.ProtocolBaseModel`
-
-```{autodoc2-docstring} boardwalkd.protocol.WorkspaceSemaphores
-```
-
-```{rubric} Initialization
-```
-
-```{autodoc2-docstring} boardwalkd.protocol.WorkspaceSemaphores.__init__
-```
-
-````{py:attribute} caught
-:canonical: boardwalkd.protocol.WorkspaceSemaphores.caught
-:type: bool
-:value: >
- False
-
-```{autodoc2-docstring} boardwalkd.protocol.WorkspaceSemaphores.caught
-```
-
-````
-
-````{py:attribute} has_mutex
-:canonical: boardwalkd.protocol.WorkspaceSemaphores.has_mutex
-:type: bool
-:value: >
- False
-
-```{autodoc2-docstring} boardwalkd.protocol.WorkspaceSemaphores.has_mutex
-```
-
-````
-
-`````
-
-````{py:exception} WorkspaceNotFound()
-:canonical: boardwalkd.protocol.WorkspaceNotFound
-
-Bases: {py:obj}`Exception`
-
-```{autodoc2-docstring} boardwalkd.protocol.WorkspaceNotFound
-```
-
-```{rubric} Initialization
-```
-
-```{autodoc2-docstring} boardwalkd.protocol.WorkspaceNotFound.__init__
-```
-
-````
-
-````{py:exception} WorkspaceHasMutex()
-:canonical: boardwalkd.protocol.WorkspaceHasMutex
-
-Bases: {py:obj}`Exception`
-
-```{autodoc2-docstring} boardwalkd.protocol.WorkspaceHasMutex
-```
-
-```{rubric} Initialization
-```
-
-```{autodoc2-docstring} boardwalkd.protocol.WorkspaceHasMutex.__init__
-```
-
-````
-
-`````{py:class} Client(url: str)
-:canonical: boardwalkd.protocol.Client
-
-```{autodoc2-docstring} boardwalkd.protocol.Client
-```
-
-```{rubric} Initialization
-```
-
-```{autodoc2-docstring} boardwalkd.protocol.Client.__init__
-```
-
-````{py:method} get_api_token() -> str
-:canonical: boardwalkd.protocol.Client.get_api_token
-
-```{autodoc2-docstring} boardwalkd.protocol.Client.get_api_token
-```
-
-````
-
-````{py:method} api_login()
-:canonical: boardwalkd.protocol.Client.api_login
-:async:
-
-```{autodoc2-docstring} boardwalkd.protocol.Client.api_login
-```
-
-````
-
-````{py:method} authenticated_request(path: str, method: str = 'GET', body: bytes | str | None = None, auto_login_prompt: bool = True) -> tornado.httpclient.HTTPResponse
-:canonical: boardwalkd.protocol.Client.authenticated_request
-
-```{autodoc2-docstring} boardwalkd.protocol.Client.authenticated_request
-```
-
-````
-
-````{py:method} workspace_delete_mutex(workspace_name: str)
-:canonical: boardwalkd.protocol.Client.workspace_delete_mutex
-
-```{autodoc2-docstring} boardwalkd.protocol.Client.workspace_delete_mutex
-```
-
-````
-
-````{py:method} workspace_get_details(workspace_name: str) -> boardwalkd.protocol.WorkspaceDetails
-:canonical: boardwalkd.protocol.Client.workspace_get_details
-
-```{autodoc2-docstring} boardwalkd.protocol.Client.workspace_get_details
-```
-
-````
-
-````{py:method} workspace_post_catch(workspace_name: str)
-:canonical: boardwalkd.protocol.Client.workspace_post_catch
-
-```{autodoc2-docstring} boardwalkd.protocol.Client.workspace_post_catch
-```
-
-````
-
-````{py:method} workspace_post_details(workspace_name: str, workspace_details: boardwalkd.protocol.WorkspaceDetails)
-:canonical: boardwalkd.protocol.Client.workspace_post_details
-
-```{autodoc2-docstring} boardwalkd.protocol.Client.workspace_post_details
-```
-
-````
-
-````{py:method} workspace_post_heartbeat(workspace_name: str)
-:canonical: boardwalkd.protocol.Client.workspace_post_heartbeat
-
-```{autodoc2-docstring} boardwalkd.protocol.Client.workspace_post_heartbeat
-```
-
-````
-
-````{py:method} workspace_heartbeat_keepalive(workspace_name: str, quit: threading.Event) -> None
-:canonical: boardwalkd.protocol.Client.workspace_heartbeat_keepalive
-
-```{autodoc2-docstring} boardwalkd.protocol.Client.workspace_heartbeat_keepalive
-```
-
-````
-
-````{py:method} workspace_heartbeat_keepalive_connect(workspace_name: str) -> threading.Event
-:canonical: boardwalkd.protocol.Client.workspace_heartbeat_keepalive_connect
-
-```{autodoc2-docstring} boardwalkd.protocol.Client.workspace_heartbeat_keepalive_connect
-```
-
-````
-
-````{py:method} workspace_post_event(workspace_name: str, workspace_event: boardwalkd.protocol.WorkspaceEvent, broadcast: bool = False)
-:canonical: boardwalkd.protocol.Client.workspace_post_event
-
-```{autodoc2-docstring} boardwalkd.protocol.Client.workspace_post_event
-```
-
-````
-
-````{py:method} workspace_queue_event(workspace_name: str, workspace_event: boardwalkd.protocol.WorkspaceEvent, broadcast: bool = False)
-:canonical: boardwalkd.protocol.Client.workspace_queue_event
-
-```{autodoc2-docstring} boardwalkd.protocol.Client.workspace_queue_event
-```
-
-````
-
-````{py:method} flush_event_queue()
-:canonical: boardwalkd.protocol.Client.flush_event_queue
-
-```{autodoc2-docstring} boardwalkd.protocol.Client.flush_event_queue
-```
-
-````
-
-````{py:method} workspace_post_mutex(workspace_name: str)
-:canonical: boardwalkd.protocol.Client.workspace_post_mutex
-
-```{autodoc2-docstring} boardwalkd.protocol.Client.workspace_post_mutex
-```
-
-````
-
-````{py:method} workspace_get_semaphores(workspace_name: str) -> boardwalkd.protocol.WorkspaceSemaphores
-:canonical: boardwalkd.protocol.Client.workspace_get_semaphores
-
-```{autodoc2-docstring} boardwalkd.protocol.Client.workspace_get_semaphores
-```
-
-````
-
-`````
-
-`````{py:class} WorkspaceClient(url: str, workspace_name: str)
-:canonical: boardwalkd.protocol.WorkspaceClient
-
-Bases: {py:obj}`boardwalkd.protocol.Client`
-
-```{autodoc2-docstring} boardwalkd.protocol.WorkspaceClient
-```
-
-```{rubric} Initialization
-```
-
-```{autodoc2-docstring} boardwalkd.protocol.WorkspaceClient.__init__
-```
-
-````{py:method} get_semaphores() -> boardwalkd.protocol.WorkspaceSemaphores
-:canonical: boardwalkd.protocol.WorkspaceClient.get_semaphores
-
-```{autodoc2-docstring} boardwalkd.protocol.WorkspaceClient.get_semaphores
-```
-
-````
-
-````{py:method} has_mutex() -> bool
-:canonical: boardwalkd.protocol.WorkspaceClient.has_mutex
-
-```{autodoc2-docstring} boardwalkd.protocol.WorkspaceClient.has_mutex
-```
-
-````
-
-````{py:method} post_catch()
-:canonical: boardwalkd.protocol.WorkspaceClient.post_catch
-
-```{autodoc2-docstring} boardwalkd.protocol.WorkspaceClient.post_catch
-```
-
-````
-
-````{py:method} caught() -> bool
-:canonical: boardwalkd.protocol.WorkspaceClient.caught
-
-```{autodoc2-docstring} boardwalkd.protocol.WorkspaceClient.caught
-```
-
-````
-
-````{py:method} heartbeat_keepalive_connect()
-:canonical: boardwalkd.protocol.WorkspaceClient.heartbeat_keepalive_connect
-
-```{autodoc2-docstring} boardwalkd.protocol.WorkspaceClient.heartbeat_keepalive_connect
-```
-
-````
-
-````{py:method} mutex()
-:canonical: boardwalkd.protocol.WorkspaceClient.mutex
-
-```{autodoc2-docstring} boardwalkd.protocol.WorkspaceClient.mutex
-```
-
-````
-
-````{py:method} post_details(workspace_details: boardwalkd.protocol.WorkspaceDetails)
-:canonical: boardwalkd.protocol.WorkspaceClient.post_details
-
-```{autodoc2-docstring} boardwalkd.protocol.WorkspaceClient.post_details
-```
-
-````
-
-````{py:method} post_heartbeat()
-:canonical: boardwalkd.protocol.WorkspaceClient.post_heartbeat
-
-```{autodoc2-docstring} boardwalkd.protocol.WorkspaceClient.post_heartbeat
-```
-
-````
-
-````{py:method} post_event(workspace_event: boardwalkd.protocol.WorkspaceEvent, broadcast: bool = False)
-:canonical: boardwalkd.protocol.WorkspaceClient.post_event
-
-```{autodoc2-docstring} boardwalkd.protocol.WorkspaceClient.post_event
-```
-
-````
-
-````{py:method} queue_event(workspace_event: boardwalkd.protocol.WorkspaceEvent, broadcast: bool = False)
-:canonical: boardwalkd.protocol.WorkspaceClient.queue_event
-
-```{autodoc2-docstring} boardwalkd.protocol.WorkspaceClient.queue_event
-```
-
-````
-
-````{py:method} unmutex()
-:canonical: boardwalkd.protocol.WorkspaceClient.unmutex
-
-```{autodoc2-docstring} boardwalkd.protocol.WorkspaceClient.unmutex
-```
-
-````
-
-`````
diff --git a/docs/source/apidocs/boardwalkd/boardwalkd.server.md b/docs/source/apidocs/boardwalkd/boardwalkd.server.md
deleted file mode 100644
index 1f93a9c..0000000
--- a/docs/source/apidocs/boardwalkd/boardwalkd.server.md
+++ /dev/null
@@ -1,1005 +0,0 @@
-# {py:mod}`boardwalkd.server`
-
-```{py:module} boardwalkd.server
-```
-
-```{autodoc2-docstring} boardwalkd.server
-:allowtitles:
-```
-
-## Module Contents
-
-### Classes
-
-````{list-table}
-:class: autosummary longtable
-:align: left
-
-* - {py:obj}`UIBaseHandler `
- - ```{autodoc2-docstring} boardwalkd.server.UIBaseHandler
- :summary:
- ```
-* - {py:obj}`AdminUIBaseHandler `
- - ```{autodoc2-docstring} boardwalkd.server.AdminUIBaseHandler
- :summary:
- ```
-* - {py:obj}`AdminHandler `
- - ```{autodoc2-docstring} boardwalkd.server.AdminHandler
- :summary:
- ```
-* - {py:obj}`UserEnableHandler `
- - ```{autodoc2-docstring} boardwalkd.server.UserEnableHandler
- :summary:
- ```
-* - {py:obj}`UserRoleHandler `
- - ```{autodoc2-docstring} boardwalkd.server.UserRoleHandler
- :summary:
- ```
-* - {py:obj}`AnonymousLoginHandler `
- - ```{autodoc2-docstring} boardwalkd.server.AnonymousLoginHandler
- :summary:
- ```
-* - {py:obj}`GoogleOAuth2LoginHandler `
- - ```{autodoc2-docstring} boardwalkd.server.GoogleOAuth2LoginHandler
- :summary:
- ```
-* - {py:obj}`IndexHandler `
- - ```{autodoc2-docstring} boardwalkd.server.IndexHandler
- :summary:
- ```
-* - {py:obj}`WorkspaceCatchHandler `
- - ```{autodoc2-docstring} boardwalkd.server.WorkspaceCatchHandler
- :summary:
- ```
-* - {py:obj}`WorkspaceEventsHandler `
- - ```{autodoc2-docstring} boardwalkd.server.WorkspaceEventsHandler
- :summary:
- ```
-* - {py:obj}`WorkspaceEventsTableHandler `
- - ```{autodoc2-docstring} boardwalkd.server.WorkspaceEventsTableHandler
- :summary:
- ```
-* - {py:obj}`WorkspaceMutexHandler `
- - ```{autodoc2-docstring} boardwalkd.server.WorkspaceMutexHandler
- :summary:
- ```
-* - {py:obj}`WorkspaceDeleteHandler `
- - ```{autodoc2-docstring} boardwalkd.server.WorkspaceDeleteHandler
- :summary:
- ```
-* - {py:obj}`WorkspacesHandler `
- - ```{autodoc2-docstring} boardwalkd.server.WorkspacesHandler
- :summary:
- ```
-* - {py:obj}`APIBaseHandler `
- - ```{autodoc2-docstring} boardwalkd.server.APIBaseHandler
- :summary:
- ```
-* - {py:obj}`AuthLoginApiHandler `
- - ```{autodoc2-docstring} boardwalkd.server.AuthLoginApiHandler
- :summary:
- ```
-* - {py:obj}`AuthLoginApiWebsocketHandler `
- - ```{autodoc2-docstring} boardwalkd.server.AuthLoginApiWebsocketHandler
- :summary:
- ```
-* - {py:obj}`AuthApiDenied `
- - ```{autodoc2-docstring} boardwalkd.server.AuthApiDenied
- :summary:
- ```
-* - {py:obj}`WorkspaceCatchApiHandler `
- - ```{autodoc2-docstring} boardwalkd.server.WorkspaceCatchApiHandler
- :summary:
- ```
-* - {py:obj}`WorkspaceDetailsApiHandler `
- - ```{autodoc2-docstring} boardwalkd.server.WorkspaceDetailsApiHandler
- :summary:
- ```
-* - {py:obj}`WorkspaceHeartbeatApiHandler `
- - ```{autodoc2-docstring} boardwalkd.server.WorkspaceHeartbeatApiHandler
- :summary:
- ```
-* - {py:obj}`WorkspaceEventApiHandler `
- - ```{autodoc2-docstring} boardwalkd.server.WorkspaceEventApiHandler
- :summary:
- ```
-* - {py:obj}`WorkspaceMutexApiHandler `
- - ```{autodoc2-docstring} boardwalkd.server.WorkspaceMutexApiHandler
- :summary:
- ```
-* - {py:obj}`WorkspaceSemaphoresApiHandler `
- - ```{autodoc2-docstring} boardwalkd.server.WorkspaceSemaphoresApiHandler
- :summary:
- ```
-````
-
-### Functions
-
-````{list-table}
-:class: autosummary longtable
-:align: left
-
-* - {py:obj}`ui_method_sha256 `
- - ```{autodoc2-docstring} boardwalkd.server.ui_method_sha256
- :summary:
- ```
-* - {py:obj}`ui_method_secondsdelta `
- - ```{autodoc2-docstring} boardwalkd.server.ui_method_secondsdelta
- :summary:
- ```
-* - {py:obj}`ui_method_server_version 
+