Skip to content

docs(oauth): use a variable "base_dir" home path for file stores #1760

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
merged 3 commits into from
Oct 16, 2025
Merged

docs(oauth): use a variable "base_dir" home path for file stores #1760

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e808aba
docs(oauth): use a variable homedir for file stores
zimeg Oct 2, 2025
6337ddd
chore: merge w main
zimeg Oct 16, 2025
d15f94b
chore: merge w main
zimeg Oct 16, 2025
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
2 changes: 1 addition & 1 deletion docs/reference/oauth/installation_store/file/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
<dl>
<dt id="slack_sdk.oauth.installation_store.file.FileInstallationStore"><code class="flex name class">
<span>class <span class="ident">FileInstallationStore</span></span>
<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>
<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>
</code></dt>
<dd>
<details class="source">
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/oauth/installation_store/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -327,7 +327,7 @@ <h3>Methods</h3>
</dd>
<dt id="slack_sdk.oauth.installation_store.FileInstallationStore"><code class="flex name class">
<span>class <span class="ident">FileInstallationStore</span></span>
<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>
<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>
</code></dt>
<dd>
<details class="source">
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/oauth/state_store/file/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
<dl>
<dt id="slack_sdk.oauth.state_store.file.FileOAuthStateStore"><code class="flex name class">
<span>class <span class="ident">FileOAuthStateStore</span></span>
<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>
<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>
</code></dt>
<dd>
<details class="source">
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/oauth/state_store/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
<dl>
<dt id="slack_sdk.oauth.state_store.FileOAuthStateStore"><code class="flex name class">
<span>class <span class="ident">FileOAuthStateStore</span></span>
<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>
<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>
</code></dt>
<dd>
<details class="source">
Expand Down
2 changes: 1 addition & 1 deletion scripts/generate_api_docs.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ pip install -U -r requirements/optional.txt

rm -rf docs/reference

pdoc slack_sdk --html -o docs/reference
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🗣️ note: This change keeps this script consistent going forward! As far as I can tell, overriding the HOME variable causes no problem for pdoc or reference.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Praise 🙏

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

praise: Very clever!

HOME="\$HOME" pdoc slack_sdk --html -o docs/reference
cp -R docs/reference/slack_sdk/* docs/reference/
rm -rf docs/reference/slack_sdk

Expand Down