Skip to content

Commit

Permalink
chore: generate the docs (slackapi#1098)
Browse files Browse the repository at this point in the history
  • Loading branch information
WilliamBergamin authored Jun 21, 2024
1 parent fed5c81 commit b88d0fc
Show file tree
Hide file tree
Showing 35 changed files with 1,815 additions and 293 deletions.
4 changes: 3 additions & 1 deletion .github/maintainers_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,10 +153,12 @@ password: {your password}

#### Production Deployment

1. Create the commit for the release:
1. Create the commit for the release:
- Bump the version number in adherence to [Semantic Versioning](http://semver.org/) in `slack_bolt/version.py`
- Build the docs with `./scripts/generate_api_docs.sh`.
- Commit with a message including the new version number. For example `1.2.3` & Push the commit to a branch and create a PR to sanity check.
- `git checkout -b v1.2.3-release`
- `git add --all`
- `git commit -m 'version 1.2.3'`
- `git push {your-fork} v1.2.3-release`
- Merge in release PR after getting an approval from at least one maintainer.
Expand Down
15 changes: 0 additions & 15 deletions docs/api-docs/slack_bolt/adapter/asgi/builtin/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -166,17 +166,6 @@ <h3>Subclasses</h3>
<ul class="hlist">
<li><a title="slack_bolt.adapter.asgi.aiohttp.AsyncSlackRequestHandler" href="../aiohttp/index.html#slack_bolt.adapter.asgi.aiohttp.AsyncSlackRequestHandler">AsyncSlackRequestHandler</a></li>
</ul>
<h3>Class variables</h3>
<dl>
<dt id="slack_bolt.adapter.asgi.builtin.SlackRequestHandler.app"><code class="name">var <span class="ident">app</span><a title="slack_bolt.app.app.App" href="../../../app/app.html#slack_bolt.app.app.App">App</a></code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt id="slack_bolt.adapter.asgi.builtin.SlackRequestHandler.path"><code class="name">var <span class="ident">path</span> : str</code></dt>
<dd>
<div class="desc"></div>
</dd>
</dl>
<h3>Inherited members</h3>
<ul class="hlist">
<li><code><b><a title="slack_bolt.adapter.asgi.base_handler.BaseSlackRequestHandler" href="../base_handler.html#slack_bolt.adapter.asgi.base_handler.BaseSlackRequestHandler">BaseSlackRequestHandler</a></b></code>:
Expand Down Expand Up @@ -206,10 +195,6 @@ <h1>Index</h1>
<ul>
<li>
<h4><code><a title="slack_bolt.adapter.asgi.builtin.SlackRequestHandler" href="#slack_bolt.adapter.asgi.builtin.SlackRequestHandler">SlackRequestHandler</a></code></h4>
<ul class="">
<li><code><a title="slack_bolt.adapter.asgi.builtin.SlackRequestHandler.app" href="#slack_bolt.adapter.asgi.builtin.SlackRequestHandler.app">app</a></code></li>
<li><code><a title="slack_bolt.adapter.asgi.builtin.SlackRequestHandler.path" href="#slack_bolt.adapter.asgi.builtin.SlackRequestHandler.path">path</a></code></li>
</ul>
</li>
</ul>
</li>
Expand Down
15 changes: 0 additions & 15 deletions docs/api-docs/slack_bolt/adapter/asgi/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -149,17 +149,6 @@ <h3>Subclasses</h3>
<ul class="hlist">
<li><a title="slack_bolt.adapter.asgi.aiohttp.AsyncSlackRequestHandler" href="aiohttp/index.html#slack_bolt.adapter.asgi.aiohttp.AsyncSlackRequestHandler">AsyncSlackRequestHandler</a></li>
</ul>
<h3>Class variables</h3>
<dl>
<dt id="slack_bolt.adapter.asgi.SlackRequestHandler.app"><code class="name">var <span class="ident">app</span><a title="slack_bolt.app.app.App" href="../../app/app.html#slack_bolt.app.app.App">App</a></code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt id="slack_bolt.adapter.asgi.SlackRequestHandler.path"><code class="name">var <span class="ident">path</span> : str</code></dt>
<dd>
<div class="desc"></div>
</dd>
</dl>
<h3>Inherited members</h3>
<ul class="hlist">
<li><code><b><a title="slack_bolt.adapter.asgi.base_handler.BaseSlackRequestHandler" href="base_handler.html#slack_bolt.adapter.asgi.base_handler.BaseSlackRequestHandler">BaseSlackRequestHandler</a></b></code>:
Expand Down Expand Up @@ -200,10 +189,6 @@ <h1>Index</h1>
<ul>
<li>
<h4><code><a title="slack_bolt.adapter.asgi.SlackRequestHandler" href="#slack_bolt.adapter.asgi.SlackRequestHandler">SlackRequestHandler</a></code></h4>
<ul class="">
<li><code><a title="slack_bolt.adapter.asgi.SlackRequestHandler.app" href="#slack_bolt.adapter.asgi.SlackRequestHandler.app">app</a></code></li>
<li><code><a title="slack_bolt.adapter.asgi.SlackRequestHandler.path" href="#slack_bolt.adapter.asgi.SlackRequestHandler.path">path</a></code></li>
</ul>
</li>
</ul>
</li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -119,13 +119,6 @@ <h3>Ancestors</h3>
<ul class="hlist">
<li><a title="slack_bolt.lazy_listener.runner.LazyListenerRunner" href="../../lazy_listener/runner.html#slack_bolt.lazy_listener.runner.LazyListenerRunner">LazyListenerRunner</a></li>
</ul>
<h3>Class variables</h3>
<dl>
<dt id="slack_bolt.adapter.aws_lambda.chalice_lazy_listener_runner.ChaliceLazyListenerRunner.logger"><code class="name">var <span class="ident">logger</span> : logging.Logger</code></dt>
<dd>
<div class="desc"></div>
</dd>
</dl>
<h3>Inherited members</h3>
<ul class="hlist">
<li><code><b><a title="slack_bolt.lazy_listener.runner.LazyListenerRunner" href="../../lazy_listener/runner.html#slack_bolt.lazy_listener.runner.LazyListenerRunner">LazyListenerRunner</a></b></code>:
Expand Down Expand Up @@ -154,9 +147,6 @@ <h1>Index</h1>
<ul>
<li>
<h4><code><a title="slack_bolt.adapter.aws_lambda.chalice_lazy_listener_runner.ChaliceLazyListenerRunner" href="#slack_bolt.adapter.aws_lambda.chalice_lazy_listener_runner.ChaliceLazyListenerRunner">ChaliceLazyListenerRunner</a></code></h4>
<ul class="">
<li><code><a title="slack_bolt.adapter.aws_lambda.chalice_lazy_listener_runner.ChaliceLazyListenerRunner.logger" href="#slack_bolt.adapter.aws_lambda.chalice_lazy_listener_runner.ChaliceLazyListenerRunner.logger">logger</a></code></li>
</ul>
</li>
</ul>
</li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -198,37 +198,6 @@ <h3>Ancestors</h3>
<ul class="hlist">
<li><a title="slack_bolt.oauth.oauth_flow.OAuthFlow" href="../../oauth/oauth_flow.html#slack_bolt.oauth.oauth_flow.OAuthFlow">OAuthFlow</a></li>
</ul>
<h3>Class variables</h3>
<dl>
<dt id="slack_bolt.adapter.aws_lambda.lambda_s3_oauth_flow.LambdaS3OAuthFlow.client_id"><code class="name">var <span class="ident">client_id</span> : str</code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt id="slack_bolt.adapter.aws_lambda.lambda_s3_oauth_flow.LambdaS3OAuthFlow.failure_handler"><code class="name">var <span class="ident">failure_handler</span> : Callable[[<a title="slack_bolt.oauth.callback_options.FailureArgs" href="../../oauth/callback_options.html#slack_bolt.oauth.callback_options.FailureArgs">FailureArgs</a>], <a title="slack_bolt.response.response.BoltResponse" href="../../response/response.html#slack_bolt.response.response.BoltResponse">BoltResponse</a>]</code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt id="slack_bolt.adapter.aws_lambda.lambda_s3_oauth_flow.LambdaS3OAuthFlow.install_path"><code class="name">var <span class="ident">install_path</span> : str</code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt id="slack_bolt.adapter.aws_lambda.lambda_s3_oauth_flow.LambdaS3OAuthFlow.redirect_uri"><code class="name">var <span class="ident">redirect_uri</span> : Optional[str]</code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt id="slack_bolt.adapter.aws_lambda.lambda_s3_oauth_flow.LambdaS3OAuthFlow.redirect_uri_path"><code class="name">var <span class="ident">redirect_uri_path</span> : str</code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt id="slack_bolt.adapter.aws_lambda.lambda_s3_oauth_flow.LambdaS3OAuthFlow.settings"><code class="name">var <span class="ident">settings</span><a title="slack_bolt.oauth.oauth_settings.OAuthSettings" href="../../oauth/oauth_settings.html#slack_bolt.oauth.oauth_settings.OAuthSettings">OAuthSettings</a></code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt id="slack_bolt.adapter.aws_lambda.lambda_s3_oauth_flow.LambdaS3OAuthFlow.success_handler"><code class="name">var <span class="ident">success_handler</span> : Callable[[<a title="slack_bolt.oauth.callback_options.SuccessArgs" href="../../oauth/callback_options.html#slack_bolt.oauth.callback_options.SuccessArgs">SuccessArgs</a>], <a title="slack_bolt.response.response.BoltResponse" href="../../response/response.html#slack_bolt.response.response.BoltResponse">BoltResponse</a>]</code></dt>
<dd>
<div class="desc"></div>
</dd>
</dl>
<h3>Instance variables</h3>
<dl>
<dt id="slack_bolt.adapter.aws_lambda.lambda_s3_oauth_flow.LambdaS3OAuthFlow.client"><code class="name">var <span class="ident">client</span> : slack_sdk.web.client.WebClient</code></dt>
Expand Down Expand Up @@ -279,16 +248,9 @@ <h1>Index</h1>
<ul>
<li>
<h4><code><a title="slack_bolt.adapter.aws_lambda.lambda_s3_oauth_flow.LambdaS3OAuthFlow" href="#slack_bolt.adapter.aws_lambda.lambda_s3_oauth_flow.LambdaS3OAuthFlow">LambdaS3OAuthFlow</a></code></h4>
<ul class="two-column">
<ul class="">
<li><code><a title="slack_bolt.adapter.aws_lambda.lambda_s3_oauth_flow.LambdaS3OAuthFlow.client" href="#slack_bolt.adapter.aws_lambda.lambda_s3_oauth_flow.LambdaS3OAuthFlow.client">client</a></code></li>
<li><code><a title="slack_bolt.adapter.aws_lambda.lambda_s3_oauth_flow.LambdaS3OAuthFlow.client_id" href="#slack_bolt.adapter.aws_lambda.lambda_s3_oauth_flow.LambdaS3OAuthFlow.client_id">client_id</a></code></li>
<li><code><a title="slack_bolt.adapter.aws_lambda.lambda_s3_oauth_flow.LambdaS3OAuthFlow.failure_handler" href="#slack_bolt.adapter.aws_lambda.lambda_s3_oauth_flow.LambdaS3OAuthFlow.failure_handler">failure_handler</a></code></li>
<li><code><a title="slack_bolt.adapter.aws_lambda.lambda_s3_oauth_flow.LambdaS3OAuthFlow.install_path" href="#slack_bolt.adapter.aws_lambda.lambda_s3_oauth_flow.LambdaS3OAuthFlow.install_path">install_path</a></code></li>
<li><code><a title="slack_bolt.adapter.aws_lambda.lambda_s3_oauth_flow.LambdaS3OAuthFlow.logger" href="#slack_bolt.adapter.aws_lambda.lambda_s3_oauth_flow.LambdaS3OAuthFlow.logger">logger</a></code></li>
<li><code><a title="slack_bolt.adapter.aws_lambda.lambda_s3_oauth_flow.LambdaS3OAuthFlow.redirect_uri" href="#slack_bolt.adapter.aws_lambda.lambda_s3_oauth_flow.LambdaS3OAuthFlow.redirect_uri">redirect_uri</a></code></li>
<li><code><a title="slack_bolt.adapter.aws_lambda.lambda_s3_oauth_flow.LambdaS3OAuthFlow.redirect_uri_path" href="#slack_bolt.adapter.aws_lambda.lambda_s3_oauth_flow.LambdaS3OAuthFlow.redirect_uri_path">redirect_uri_path</a></code></li>
<li><code><a title="slack_bolt.adapter.aws_lambda.lambda_s3_oauth_flow.LambdaS3OAuthFlow.settings" href="#slack_bolt.adapter.aws_lambda.lambda_s3_oauth_flow.LambdaS3OAuthFlow.settings">settings</a></code></li>
<li><code><a title="slack_bolt.adapter.aws_lambda.lambda_s3_oauth_flow.LambdaS3OAuthFlow.success_handler" href="#slack_bolt.adapter.aws_lambda.lambda_s3_oauth_flow.LambdaS3OAuthFlow.success_handler">success_handler</a></code></li>
</ul>
</li>
</ul>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -102,13 +102,6 @@ <h3>Ancestors</h3>
<ul class="hlist">
<li><a title="slack_bolt.lazy_listener.runner.LazyListenerRunner" href="../../lazy_listener/runner.html#slack_bolt.lazy_listener.runner.LazyListenerRunner">LazyListenerRunner</a></li>
</ul>
<h3>Class variables</h3>
<dl>
<dt id="slack_bolt.adapter.aws_lambda.lazy_listener_runner.LambdaLazyListenerRunner.logger"><code class="name">var <span class="ident">logger</span> : logging.Logger</code></dt>
<dd>
<div class="desc"></div>
</dd>
</dl>
<h3>Inherited members</h3>
<ul class="hlist">
<li><code><b><a title="slack_bolt.lazy_listener.runner.LazyListenerRunner" href="../../lazy_listener/runner.html#slack_bolt.lazy_listener.runner.LazyListenerRunner">LazyListenerRunner</a></b></code>:
Expand Down Expand Up @@ -137,9 +130,6 @@ <h1>Index</h1>
<ul>
<li>
<h4><code><a title="slack_bolt.adapter.aws_lambda.lazy_listener_runner.LambdaLazyListenerRunner" href="#slack_bolt.adapter.aws_lambda.lazy_listener_runner.LambdaLazyListenerRunner">LambdaLazyListenerRunner</a></code></h4>
<ul class="">
<li><code><a title="slack_bolt.adapter.aws_lambda.lazy_listener_runner.LambdaLazyListenerRunner.logger" href="#slack_bolt.adapter.aws_lambda.lazy_listener_runner.LambdaLazyListenerRunner.logger">logger</a></code></li>
</ul>
</li>
</ul>
</li>
Expand Down
10 changes: 0 additions & 10 deletions docs/api-docs/slack_bolt/adapter/django/handler.html
Original file line number Diff line number Diff line change
Expand Up @@ -389,13 +389,6 @@ <h3>Ancestors</h3>
<li><a title="slack_bolt.lazy_listener.thread_runner.ThreadLazyListenerRunner" href="../../lazy_listener/thread_runner.html#slack_bolt.lazy_listener.thread_runner.ThreadLazyListenerRunner">ThreadLazyListenerRunner</a></li>
<li><a title="slack_bolt.lazy_listener.runner.LazyListenerRunner" href="../../lazy_listener/runner.html#slack_bolt.lazy_listener.runner.LazyListenerRunner">LazyListenerRunner</a></li>
</ul>
<h3>Class variables</h3>
<dl>
<dt id="slack_bolt.adapter.django.handler.DjangoThreadLazyListenerRunner.logger"><code class="name">var <span class="ident">logger</span> : logging.Logger</code></dt>
<dd>
<div class="desc"></div>
</dd>
</dl>
<h3>Inherited members</h3>
<ul class="hlist">
<li><code><b><a title="slack_bolt.lazy_listener.thread_runner.ThreadLazyListenerRunner" href="../../lazy_listener/thread_runner.html#slack_bolt.lazy_listener.thread_runner.ThreadLazyListenerRunner">ThreadLazyListenerRunner</a></b></code>:
Expand Down Expand Up @@ -546,9 +539,6 @@ <h4><code><a title="slack_bolt.adapter.django.handler.DjangoListenerStartHandler
</li>
<li>
<h4><code><a title="slack_bolt.adapter.django.handler.DjangoThreadLazyListenerRunner" href="#slack_bolt.adapter.django.handler.DjangoThreadLazyListenerRunner">DjangoThreadLazyListenerRunner</a></code></h4>
<ul class="">
<li><code><a title="slack_bolt.adapter.django.handler.DjangoThreadLazyListenerRunner.logger" href="#slack_bolt.adapter.django.handler.DjangoThreadLazyListenerRunner.logger">logger</a></code></li>
</ul>
</li>
<li>
<h4><code><a title="slack_bolt.adapter.django.handler.SlackRequestHandler" href="#slack_bolt.adapter.django.handler.SlackRequestHandler">SlackRequestHandler</a></code></h4>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -101,13 +101,6 @@ <h3>Ancestors</h3>
<ul class="hlist">
<li><a title="slack_bolt.lazy_listener.runner.LazyListenerRunner" href="../../lazy_listener/runner.html#slack_bolt.lazy_listener.runner.LazyListenerRunner">LazyListenerRunner</a></li>
</ul>
<h3>Class variables</h3>
<dl>
<dt id="slack_bolt.adapter.google_cloud_functions.handler.NoopLazyListenerRunner.logger"><code class="name">var <span class="ident">logger</span> : logging.Logger</code></dt>
<dd>
<div class="desc"></div>
</dd>
</dl>
<h3>Inherited members</h3>
<ul class="hlist">
<li><code><b><a title="slack_bolt.lazy_listener.runner.LazyListenerRunner" href="../../lazy_listener/runner.html#slack_bolt.lazy_listener.runner.LazyListenerRunner">LazyListenerRunner</a></b></code>:
Expand Down Expand Up @@ -198,9 +191,6 @@ <h1>Index</h1>
<ul>
<li>
<h4><code><a title="slack_bolt.adapter.google_cloud_functions.handler.NoopLazyListenerRunner" href="#slack_bolt.adapter.google_cloud_functions.handler.NoopLazyListenerRunner">NoopLazyListenerRunner</a></code></h4>
<ul class="">
<li><code><a title="slack_bolt.adapter.google_cloud_functions.handler.NoopLazyListenerRunner.logger" href="#slack_bolt.adapter.google_cloud_functions.handler.NoopLazyListenerRunner.logger">logger</a></code></li>
</ul>
</li>
<li>
<h4><code><a title="slack_bolt.adapter.google_cloud_functions.handler.SlackRequestHandler" href="#slack_bolt.adapter.google_cloud_functions.handler.SlackRequestHandler">SlackRequestHandler</a></code></h4>
Expand Down
5 changes: 5 additions & 0 deletions docs/api-docs/slack_bolt/adapter/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,10 @@ <h2 class="section-title" id="header-submodules">Sub-modules</h2>
<dd>
<div class="desc"></div>
</dd>
<dt><code class="name"><a title="slack_bolt.adapter.wsgi" href="wsgi/index.html">slack_bolt.adapter.wsgi</a></code></dt>
<dd>
<div class="desc"></div>
</dd>
</dl>
</section>
<section>
Expand Down Expand Up @@ -131,6 +135,7 @@ <h1>Index</h1>
<li><code><a title="slack_bolt.adapter.socket_mode" href="socket_mode/index.html">slack_bolt.adapter.socket_mode</a></code></li>
<li><code><a title="slack_bolt.adapter.starlette" href="starlette/index.html">slack_bolt.adapter.starlette</a></code></li>
<li><code><a title="slack_bolt.adapter.tornado" href="tornado/index.html">slack_bolt.adapter.tornado</a></code></li>
<li><code><a title="slack_bolt.adapter.wsgi" href="wsgi/index.html">slack_bolt.adapter.wsgi</a></code></li>
</ul>
</li>
</ul>
Expand Down
6 changes: 3 additions & 3 deletions docs/api-docs/slack_bolt/adapter/sanic/async_handler.html
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ <h1 class="title">Module <code>slack_bolt.adapter.sanic.async_handler</code></h1
<h2 class="section-title" id="header-functions">Functions</h2>
<dl>
<dt id="slack_bolt.adapter.sanic.async_handler.to_async_bolt_request"><code class="name flex">
<span>def <span class="ident">to_async_bolt_request</span></span>(<span>req: sanic.request.Request) ‑> <a title="slack_bolt.request.async_request.AsyncBoltRequest" href="../../request/async_request.html#slack_bolt.request.async_request.AsyncBoltRequest">AsyncBoltRequest</a></span>
<span>def <span class="ident">to_async_bolt_request</span></span>(<span>req: sanic.request.types.Request) ‑> <a title="slack_bolt.request.async_request.AsyncBoltRequest" href="../../request/async_request.html#slack_bolt.request.async_request.AsyncBoltRequest">AsyncBoltRequest</a></span>
</code></dt>
<dd>
<div class="desc"></div>
Expand All @@ -116,7 +116,7 @@ <h2 class="section-title" id="header-functions">Functions</h2>
</details>
</dd>
<dt id="slack_bolt.adapter.sanic.async_handler.to_sanic_response"><code class="name flex">
<span>def <span class="ident">to_sanic_response</span></span>(<span>bolt_resp: <a title="slack_bolt.response.response.BoltResponse" href="../../response/response.html#slack_bolt.response.response.BoltResponse">BoltResponse</a>) ‑> sanic.response.HTTPResponse</span>
<span>def <span class="ident">to_sanic_response</span></span>(<span>bolt_resp: <a title="slack_bolt.response.response.BoltResponse" href="../../response/response.html#slack_bolt.response.response.BoltResponse">BoltResponse</a>) ‑> sanic.response.types.HTTPResponse</span>
</code></dt>
<dd>
<div class="desc"></div>
Expand Down Expand Up @@ -188,7 +188,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
<h3>Methods</h3>
<dl>
<dt id="slack_bolt.adapter.sanic.async_handler.AsyncSlackRequestHandler.handle"><code class="name flex">
<span>async def <span class="ident">handle</span></span>(<span>self, req: sanic.request.Request) ‑> sanic.response.HTTPResponse</span>
<span>async def <span class="ident">handle</span></span>(<span>self, req: sanic.request.types.Request) ‑> sanic.response.types.HTTPResponse</span>
</code></dt>
<dd>
<div class="desc"></div>
Expand Down
2 changes: 1 addition & 1 deletion docs/api-docs/slack_bolt/adapter/sanic/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
<h3>Methods</h3>
<dl>
<dt id="slack_bolt.adapter.sanic.AsyncSlackRequestHandler.handle"><code class="name flex">
<span>async def <span class="ident">handle</span></span>(<span>self, req: sanic.request.Request) ‑> sanic.response.HTTPResponse</span>
<span>async def <span class="ident">handle</span></span>(<span>self, req: sanic.request.types.Request) ‑> sanic.response.types.HTTPResponse</span>
</code></dt>
<dd>
<div class="desc"></div>
Expand Down
Loading

0 comments on commit b88d0fc

Please sign in to comment.