Skip to content

Add /api-docs/slack_bolt/ generation #263

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
seratch merged 2 commits into from
Mar 24, 2021
Merged

Add /api-docs/slack_bolt/ generation #263

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
150314f
Update docstring and add the api-docs generator script
seratch Mar 24, 2021
af86eff
Add all generated content
seratch Mar 24, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .github/maintainers_guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,12 @@ $ ngrok http 3000 --subdomain {your-domain}

### Releasing

#### Generate API documents

```bash
./scripts/generate_api_docs.sh
```

#### test.pypi.org deployment

##### $HOME/.pypirc
Expand Down
3 changes: 3 additions & 0 deletions docs/_includes/sidebar.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,9 @@
<a href="{{ site.url | append: site.baseurl | append: localized_base_url }}/tutorial/getting-started">
<li class="title">{{ site.t[page.lang].start }}</li>
</a>
<a href="{{ site.url | append: site.baseurl | append: localized_base_url }}/api-docs/slack_bolt/" target="_blank">
<li class="title">API Documents</li>
</a>
</ul>

<ul class="sidebar-section">
Expand Down
161 changes: 161 additions & 0 deletions docs/api-docs/slack_bolt/adapter/aiohttp/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,161 @@
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
<meta name="generator" content="pdoc 0.9.2" />
<title>slack_bolt.adapter.aiohttp API documentation</title>
<meta name="description" content="" />
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
<link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script>
<script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>
</head>
<body>
<main>
<article id="content">
<header>
<h1 class="title">Module <code>slack_bolt.adapter.aiohttp</code></h1>
</header>
<section id="section-intro">
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">import re

from aiohttp import web

from slack_bolt.request.async_request import AsyncBoltRequest
from slack_bolt.response import BoltResponse


async def to_bolt_request(request: web.Request) -&gt; AsyncBoltRequest:
return AsyncBoltRequest(
body=await request.text(),
query=request.query_string,
headers=request.headers,
)


async def to_aiohttp_response(bolt_resp: BoltResponse) -&gt; web.Response:
content_type = bolt_resp.headers.pop(
&#34;content-type&#34;,
[&#34;application/json&#34; if bolt_resp.body.startswith(&#34;{&#34;) else &#34;text/plain&#34;],
)[0]
content_type = re.sub(r&#34;;\s*charset=utf-8&#34;, &#34;&#34;, content_type)
resp = web.Response(
status=bolt_resp.status,
body=bolt_resp.body,
headers=bolt_resp.first_headers_without_set_cookie(),
content_type=content_type,
)
for cookie in bolt_resp.cookies():
for name, c in cookie.items():
resp.set_cookie(
name=name,
value=c.value,
max_age=c.get(&#34;max-age&#34;),
expires=c.get(&#34;expires&#34;),
path=c.get(&#34;path&#34;),
domain=c.get(&#34;domain&#34;),
secure=True,
httponly=True,
)
return resp</code></pre>
</details>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-functions">Functions</h2>
<dl>
<dt id="slack_bolt.adapter.aiohttp.to_aiohttp_response"><code class="name flex">
<span>async def <span class="ident">to_aiohttp_response</span></span>(<span>bolt_resp: <a title="slack_bolt.response.response.BoltResponse" href="../../response/response.html#slack_bolt.response.response.BoltResponse">BoltResponse</a>) ‑> aiohttp.web_response.Response</span>
</code></dt>
<dd>
<div class="desc"></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">async def to_aiohttp_response(bolt_resp: BoltResponse) -&gt; web.Response:
content_type = bolt_resp.headers.pop(
&#34;content-type&#34;,
[&#34;application/json&#34; if bolt_resp.body.startswith(&#34;{&#34;) else &#34;text/plain&#34;],
)[0]
content_type = re.sub(r&#34;;\s*charset=utf-8&#34;, &#34;&#34;, content_type)
resp = web.Response(
status=bolt_resp.status,
body=bolt_resp.body,
headers=bolt_resp.first_headers_without_set_cookie(),
content_type=content_type,
)
for cookie in bolt_resp.cookies():
for name, c in cookie.items():
resp.set_cookie(
name=name,
value=c.value,
max_age=c.get(&#34;max-age&#34;),
expires=c.get(&#34;expires&#34;),
path=c.get(&#34;path&#34;),
domain=c.get(&#34;domain&#34;),
secure=True,
httponly=True,
)
return resp</code></pre>
</details>
</dd>
<dt id="slack_bolt.adapter.aiohttp.to_bolt_request"><code class="name flex">
<span>async def <span class="ident">to_bolt_request</span></span>(<span>request: aiohttp.web_request.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>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">async def to_bolt_request(request: web.Request) -&gt; AsyncBoltRequest:
return AsyncBoltRequest(
body=await request.text(),
query=request.query_string,
headers=request.headers,
)</code></pre>
</details>
</dd>
</dl>
</section>
<section>
</section>
</article>
<nav id="sidebar">
<h1>Index</h1>
<div class="toc">
<ul></ul>
</div>
<ul id="index">
<li><h3>Super-module</h3>
<ul>
<li><code><a title="slack_bolt.adapter" href="../index.html">slack_bolt.adapter</a></code></li>
</ul>
</li>
<li><h3><a href="#header-functions">Functions</a></h3>
<ul class="">
<li><code><a title="slack_bolt.adapter.aiohttp.to_aiohttp_response" href="#slack_bolt.adapter.aiohttp.to_aiohttp_response">to_aiohttp_response</a></code></li>
<li><code><a title="slack_bolt.adapter.aiohttp.to_bolt_request" href="#slack_bolt.adapter.aiohttp.to_bolt_request">to_bolt_request</a></code></li>
</ul>
</li>
</ul>
</nav>
</main>
<footer id="footer">
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.9.2</a>.</p>
</footer>
</body>
</html>
Loading