Skip to content

Commit 344e0c5

Browse files
authored
docs(oauth): use a variable homedir for file stores (#1760)
1 parent 577d6b4 commit 344e0c5

File tree

5 files changed

+5
-5
lines changed

5 files changed

+5
-5
lines changed

docs/reference/oauth/installation_store/file/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
4848
<dl>
4949
<dt id="slack_sdk.oauth.installation_store.file.FileInstallationStore"><code class="flex name class">
5050
<span>class <span class="ident">FileInstallationStore</span></span>
51-
<span>(</span><span>*,<br>base_dir: str = '/Users/eden.zimbelman/.bolt-app-installation',<br>historical_data_enabled: bool = True,<br>client_id: str | None = None,<br>logger: logging.Logger = &lt;Logger slack_sdk.oauth.installation_store.file (WARNING)&gt;)</span>
51+
<span>(</span><span>*,<br>base_dir: str = '$HOME/.bolt-app-installation',<br>historical_data_enabled: bool = True,<br>client_id: str | None = None,<br>logger: logging.Logger = &lt;Logger slack_sdk.oauth.installation_store.file (WARNING)&gt;)</span>
5252
</code></dt>
5353
<dd>
5454
<details class="source">

docs/reference/oauth/installation_store/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -327,7 +327,7 @@ <h3>Methods</h3>
327327
</dd>
328328
<dt id="slack_sdk.oauth.installation_store.FileInstallationStore"><code class="flex name class">
329329
<span>class <span class="ident">FileInstallationStore</span></span>
330-
<span>(</span><span>*,<br>base_dir: str = '/Users/eden.zimbelman/.bolt-app-installation',<br>historical_data_enabled: bool = True,<br>client_id: str | None = None,<br>logger: logging.Logger = &lt;Logger slack_sdk.oauth.installation_store.file (WARNING)&gt;)</span>
330+
<span>(</span><span>*,<br>base_dir: str = '$HOME/.bolt-app-installation',<br>historical_data_enabled: bool = True,<br>client_id: str | None = None,<br>logger: logging.Logger = &lt;Logger slack_sdk.oauth.installation_store.file (WARNING)&gt;)</span>
331331
</code></dt>
332332
<dd>
333333
<details class="source">

docs/reference/oauth/state_store/file/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
4848
<dl>
4949
<dt id="slack_sdk.oauth.state_store.file.FileOAuthStateStore"><code class="flex name class">
5050
<span>class <span class="ident">FileOAuthStateStore</span></span>
51-
<span>(</span><span>*,<br>expiration_seconds: int,<br>base_dir: str = '/Users/eden.zimbelman/.bolt-app-oauth-state',<br>client_id: str | None = None,<br>logger: logging.Logger = &lt;Logger slack_sdk.oauth.state_store.file (WARNING)&gt;)</span>
51+
<span>(</span><span>*,<br>expiration_seconds: int,<br>base_dir: str = '$HOME/.bolt-app-oauth-state',<br>client_id: str | None = None,<br>logger: logging.Logger = &lt;Logger slack_sdk.oauth.state_store.file (WARNING)&gt;)</span>
5252
</code></dt>
5353
<dd>
5454
<details class="source">

docs/reference/oauth/state_store/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
7777
<dl>
7878
<dt id="slack_sdk.oauth.state_store.FileOAuthStateStore"><code class="flex name class">
7979
<span>class <span class="ident">FileOAuthStateStore</span></span>
80-
<span>(</span><span>*,<br>expiration_seconds: int,<br>base_dir: str = '/Users/eden.zimbelman/.bolt-app-oauth-state',<br>client_id: str | None = None,<br>logger: logging.Logger = &lt;Logger slack_sdk.oauth.state_store.file (WARNING)&gt;)</span>
80+
<span>(</span><span>*,<br>expiration_seconds: int,<br>base_dir: str = '$HOME/.bolt-app-oauth-state',<br>client_id: str | None = None,<br>logger: logging.Logger = &lt;Logger slack_sdk.oauth.state_store.file (WARNING)&gt;)</span>
8181
</code></dt>
8282
<dd>
8383
<details class="source">

scripts/generate_api_docs.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ pip install -U -r requirements/optional.txt
99

1010
rm -rf docs/reference
1111

12-
pdoc slack_sdk --html -o docs/reference
12+
HOME="\$HOME" pdoc slack_sdk --html -o docs/reference
1313
cp -R docs/reference/slack_sdk/* docs/reference/
1414
rm -rf docs/reference/slack_sdk
1515

0 commit comments

Comments
 (0)