Remove user base dir paths from generated documentation #1752

Activity

1. mwbrooks

   added

   untriaged

   docsM-T: Documentation work onlyM-T: Documentation work only

   and removed

   untriaged

   on Sep 24, 2025
2. mwbrooks

   added the

   Bug

   issue type on Sep 24, 2025
3. zimeg commented on Oct 2, 2025

   

   zimeg

   on Oct 2, 2025

   Member

   More actions

   🔍 I find the following differences when running these docs in CI and on configured machine:

   diff

   diff --git a/docs/reference/oauth/installation_store/file/index.html b/docs/reference/oauth/installation_store/file/index.html
   index 7658ddd..b972a9e 100644
   --- a/docs/reference/oauth/installation_store/file/index.html
   +++ b/docs/reference/oauth/installation_store/file/index.html
   @@ -48,7 +48,7 @@ el.replaceWith(d);
    <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/runner/.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">
   diff --git a/docs/reference/oauth/installation_store/index.html b/docs/reference/oauth/installation_store/index.html
   index 5865522..0335c69 100644
   --- a/docs/reference/oauth/installation_store/index.html
   +++ b/docs/reference/oauth/installation_store/index.html
   @@ -327,7 +327,7 @@ el.replaceWith(d);
    </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/runner/.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">
   diff --git a/docs/reference/oauth/state_store/file/index.html b/docs/reference/oauth/state_store/file/index.html
   index 33ac16d..8adf695 100644
   --- a/docs/reference/oauth/state_store/file/index.html
   +++ b/docs/reference/oauth/state_store/file/index.html
   @@ -48,7 +48,7 @@ el.replaceWith(d);
    <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/runner/.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">
   diff --git a/docs/reference/oauth/state_store/index.html b/docs/reference/oauth/state_store/index.html
   index efb7d1c..363fe78 100644
   --- a/docs/reference/oauth/state_store/index.html
   +++ b/docs/reference/oauth/state_store/index.html
   @@ -77,7 +77,7 @@ el.replaceWith(d);
    <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/runner/.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">

   🔗 https://github.com/slackapi/python-slack-sdk/actions/runs/18182991000/job/51762301843
4. zimeg

   linked a pull request that will close this issuedocs(oauth): use a variable "base_dir" home path for file stores #1760on Oct 2, 2025
5. zimeg

   closed this as completedin #1760on Oct 16, 2025