Docs: creates markdown reference

.github/workflows/ci-build.yml

@@ -58,6 +58,25 @@ jobs:
       - name: Type check all modules
         run: mypy --config-file pyproject.toml
 
+  docs-reference:
+    name: Reference docs drift
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    permissions:
+      contents: read
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+      - name: Set up Python ${{ env.LATEST_SUPPORTED_PY }}
+        uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
+        with:
+          python-version: ${{ env.LATEST_SUPPORTED_PY }}
+      - name: Generate API reference
+        run: ./scripts/generate_api_docs.sh
+      - name: Verify committed reference is up to date
+        run: git diff --exit-code -- docs/english/reference
+
   unittest:
     name: Unit tests
     runs-on: ubuntu-22.04

docs/english/_sidebar.json

@@ -118,9 +118,15 @@
 	},
 	{ "type": "html", "value": "<hr>" },
 	{
-		"type": "link",
+		"type": "category",
 		"label": "Reference",
-		"href": "https://docs.slack.dev/tools/bolt-python/reference/index.html"
+		"link": {
+			"type": "doc",
+			"id": "tools/bolt-python/reference/index"
+		  },
+		"items": [
+			{ "type": "autogenerated", "dirName": "tools/bolt-python/reference" }
+		]
 	},
 	{ "type": "html", "value": "<hr>" },
 	{

docs/english/reference/adapter/aiohttp/index.md

@@ -0,0 +1,6 @@
+---
+sidebar_label: aiohttp
+title: slack_bolt.adapter.aiohttp
+---
+
+

docs/english/reference/adapter/asgi/aiohttp/index.md

@@ -0,0 +1,35 @@
+---
+sidebar_label: aiohttp
+title: slack_bolt.adapter.asgi.aiohttp
+---
+
+## `AsyncSlackRequestHandler`
+
+```python
+AsyncSlackRequestHandler(app, path='/slack/events')
+```
+
+Bases: SlackRequestHandler
+
+Setup Bolt as an ASGI web framework, this will make your application compatible with ASGI web servers.
+
+This can be used for production deployment.
+
+With the default settings, `http://localhost:3000/slack/events`
+Run Bolt with [uvicron](https://www.uvicorn.org/)
+
+```python
+app = AsyncApp()
+api = SlackRequestHandler(app)
+```
+
+```bash
+export SLACK_SIGNING_SECRET=***
+export SLACK_BOT_TOKEN=xoxb-***
+uvicorn app:api --port 3000 --log-level debug
+```
+
+**Parameters:**
+
+- **app** (AsyncApp) – Your bolt application
+- **path** (str) – The path to handle request from Slack (Default: `/slack/events`)

docs/english/reference/adapter/asgi/async_handler.md

@@ -0,0 +1,35 @@
+---
+sidebar_label: async_handler
+title: slack_bolt.adapter.asgi.async_handler
+---
+
+## `AsyncSlackRequestHandler`
+
+```python
+AsyncSlackRequestHandler(app, path='/slack/events')
+```
+
+Bases: SlackRequestHandler
+
+Setup Bolt as an ASGI web framework, this will make your application compatible with ASGI web servers.
+
+This can be used for production deployment.
+
+With the default settings, `http://localhost:3000/slack/events`
+Run Bolt with [uvicron](https://www.uvicorn.org/)
+
+```python
+app = AsyncApp()
+api = SlackRequestHandler(app)
+```
+
+```bash
+export SLACK_SIGNING_SECRET=***
+export SLACK_BOT_TOKEN=xoxb-***
+uvicorn app:api --port 3000 --log-level debug
+```
+
+**Parameters:**
+
+- **app** (AsyncApp) – Your bolt application
+- **path** (str) – The path to handle request from Slack (Default: `/slack/events`)

docs/english/reference/adapter/asgi/base_handler.md

@@ -0,0 +1,30 @@
+---
+sidebar_label: base_handler
+title: slack_bolt.adapter.asgi.base_handler
+---
+
+## `BaseSlackRequestHandler`
+
+### `dispatch`
+
+```python
+dispatch(request)
+```
+
+Dispatches a request to the Bolt App.
+
+### `handle_callback`
+
+```python
+handle_callback(request)
+```
+
+Handles the callback of the OAuthFlow.
+
+### `handle_installation`
+
+```python
+handle_installation(request)
+```
+
+Handles installation of the OAuthFlow.

docs/english/reference/adapter/asgi/builtin/index.md

@@ -0,0 +1,35 @@
+---
+sidebar_label: builtin
+title: slack_bolt.adapter.asgi.builtin
+---
+
+## `SlackRequestHandler`
+
+```python
+SlackRequestHandler(app, path='/slack/events')
+```
+
+Bases: BaseSlackRequestHandler
+
+Setup Bolt as an ASGI web framework, this will make your application compatible with ASGI web servers.
+
+This can be used for production deployment.
+
+With the default settings, `http://localhost:3000/slack/events`
+Run Bolt with [uvicron](https://www.uvicorn.org/)
+
+```python
+app = App()
+api = SlackRequestHandler(app)
+```
+
+```bash
+export SLACK_SIGNING_SECRET=***
+export SLACK_BOT_TOKEN=xoxb-***
+uvicorn app:api --port 3000 --log-level debug
+```
+
+**Parameters:**
+
+- **app** (App) – Your bolt application
+- **path** (str) – The path to handle request from Slack (Default: `/slack/events`)

docs/english/reference/adapter/asgi/http_request.md

@@ -0,0 +1,6 @@
+---
+sidebar_label: http_request
+title: slack_bolt.adapter.asgi.http_request
+---
+
+

docs/english/reference/adapter/asgi/http_response.md

@@ -0,0 +1,6 @@
+---
+sidebar_label: http_response
+title: slack_bolt.adapter.asgi.http_response
+---
+
+

docs/english/reference/adapter/asgi/index.md

@@ -0,0 +1,45 @@
+---
+sidebar_label: asgi
+title: slack_bolt.adapter.asgi
+---
+
+## `SlackRequestHandler`
+
+```python
+SlackRequestHandler(app, path='/slack/events')
+```
+
+Bases: BaseSlackRequestHandler
+
+Setup Bolt as an ASGI web framework, this will make your application compatible with ASGI web servers.
+
+This can be used for production deployment.
+
+With the default settings, `http://localhost:3000/slack/events`
+Run Bolt with [uvicron](https://www.uvicorn.org/)
+
+```python
+app = App()
+api = SlackRequestHandler(app)
+```
+
+```bash
+export SLACK_SIGNING_SECRET=***
+export SLACK_BOT_TOKEN=xoxb-***
+uvicorn app:api --port 3000 --log-level debug
+```
+
+**Parameters:**
+
+- **app** (App) – Your bolt application
+- **path** (str) – The path to handle request from Slack (Default: `/slack/events`)
+
+## Submodules
+
+- [slack_bolt.adapter.asgi.aiohttp](/tools/bolt-python/reference/adapter/asgi/aiohttp)
+- [slack_bolt.adapter.asgi.async_handler](/tools/bolt-python/reference/adapter/asgi/async_handler)
+- [slack_bolt.adapter.asgi.base_handler](/tools/bolt-python/reference/adapter/asgi/base_handler)
+- [slack_bolt.adapter.asgi.builtin](/tools/bolt-python/reference/adapter/asgi/builtin)
+- [slack_bolt.adapter.asgi.http_request](/tools/bolt-python/reference/adapter/asgi/http_request)
+- [slack_bolt.adapter.asgi.http_response](/tools/bolt-python/reference/adapter/asgi/http_response)
+- [slack_bolt.adapter.asgi.utils](/tools/bolt-python/reference/adapter/asgi/utils)

docs/english/reference/adapter/asgi/utils.md

@@ -0,0 +1,6 @@
+---
+sidebar_label: utils
+title: slack_bolt.adapter.asgi.utils
+---
+
+

docs/english/reference/adapter/aws_lambda/chalice_handler.md

@@ -0,0 +1,6 @@
+---
+sidebar_label: chalice_handler
+title: slack_bolt.adapter.aws_lambda.chalice_handler
+---
+
+

docs/english/reference/adapter/aws_lambda/chalice_lazy_listener_runner.md

@@ -0,0 +1,6 @@
+---
+sidebar_label: chalice_lazy_listener_runner
+title: slack_bolt.adapter.aws_lambda.chalice_lazy_listener_runner
+---
+
+

docs/english/reference/adapter/aws_lambda/handler.md

@@ -0,0 +1,6 @@
+---
+sidebar_label: handler
+title: slack_bolt.adapter.aws_lambda.handler
+---
+
+

docs/english/reference/adapter/aws_lambda/index.md

@@ -0,0 +1,14 @@
+---
+sidebar_label: aws_lambda
+title: slack_bolt.adapter.aws_lambda
+---
+
+## Submodules
+
+- [slack_bolt.adapter.aws_lambda.chalice_handler](/tools/bolt-python/reference/adapter/aws_lambda/chalice_handler)
+- [slack_bolt.adapter.aws_lambda.chalice_lazy_listener_runner](/tools/bolt-python/reference/adapter/aws_lambda/chalice_lazy_listener_runner)
+- [slack_bolt.adapter.aws_lambda.handler](/tools/bolt-python/reference/adapter/aws_lambda/handler)
+- [slack_bolt.adapter.aws_lambda.internals](/tools/bolt-python/reference/adapter/aws_lambda/internals)
+- [slack_bolt.adapter.aws_lambda.lambda_s3_oauth_flow](/tools/bolt-python/reference/adapter/aws_lambda/lambda_s3_oauth_flow)
+- [slack_bolt.adapter.aws_lambda.lazy_listener_runner](/tools/bolt-python/reference/adapter/aws_lambda/lazy_listener_runner)
+- [slack_bolt.adapter.aws_lambda.local_lambda_client](/tools/bolt-python/reference/adapter/aws_lambda/local_lambda_client)

docs/english/reference/adapter/aws_lambda/internals.md

@@ -0,0 +1,6 @@
+---
+sidebar_label: internals
+title: slack_bolt.adapter.aws_lambda.internals
+---
+
+

docs/english/reference/adapter/aws_lambda/lambda_s3_oauth_flow.md

@@ -0,0 +1,6 @@
+---
+sidebar_label: lambda_s3_oauth_flow
+title: slack_bolt.adapter.aws_lambda.lambda_s3_oauth_flow
+---
+
+

docs/english/reference/adapter/aws_lambda/lazy_listener_runner.md

@@ -0,0 +1,6 @@
+---
+sidebar_label: lazy_listener_runner
+title: slack_bolt.adapter.aws_lambda.lazy_listener_runner
+---
+
+

docs/english/reference/adapter/aws_lambda/local_lambda_client.md

@@ -0,0 +1,14 @@
+---
+sidebar_label: local_lambda_client
+title: slack_bolt.adapter.aws_lambda.local_lambda_client
+---
+
+## `LocalLambdaClient`
+
+```python
+LocalLambdaClient(app, config)
+```
+
+Bases: BaseClient
+
+Lambda client implementing `invoke` for use when running with Chalice CLI.

docs/english/reference/adapter/bottle/handler.md

@@ -0,0 +1,6 @@
+---
+sidebar_label: handler
+title: slack_bolt.adapter.bottle.handler
+---
+
+

docs/english/reference/adapter/bottle/index.md

@@ -0,0 +1,8 @@
+---
+sidebar_label: bottle
+title: slack_bolt.adapter.bottle
+---
+
+## Submodules
+
+- [slack_bolt.adapter.bottle.handler](/tools/bolt-python/reference/adapter/bottle/handler)

docs/english/reference/adapter/cherrypy/handler.md

@@ -0,0 +1,6 @@
+---
+sidebar_label: handler
+title: slack_bolt.adapter.cherrypy.handler
+---
+
+

docs/english/reference/adapter/cherrypy/index.md

@@ -0,0 +1,8 @@
+---
+sidebar_label: cherrypy
+title: slack_bolt.adapter.cherrypy
+---
+
+## Submodules
+
+- [slack_bolt.adapter.cherrypy.handler](/tools/bolt-python/reference/adapter/cherrypy/handler)

docs/english/reference/adapter/django/handler.md

@@ -0,0 +1,22 @@
+---
+sidebar_label: handler
+title: slack_bolt.adapter.django.handler
+---
+
+## `DjangoListenerCompletionHandler`
+
+Bases: ListenerCompletionHandler
+
+Django sets DB connections as a thread-local variable per thread.
+
+If the thread is not managed on the Django app side, the connections won't be released by Django.
+This handler releases the connections every time a ThreadListenerRunner execution completes.
+
+## `DjangoListenerStartHandler`
+
+Bases: ListenerStartHandler
+
+Django sets DB connections as a thread-local variable per thread.
+
+If the thread is not managed on the Django app side, the connections won't be released by Django.
+This handler releases the connections every time a ThreadListenerRunner execution completes.

docs/english/reference/adapter/django/index.md

@@ -0,0 +1,8 @@
+---
+sidebar_label: django
+title: slack_bolt.adapter.django
+---
+
+## Submodules
+
+- [slack_bolt.adapter.django.handler](/tools/bolt-python/reference/adapter/django/handler)