Repository navigation
Remove user base dir paths from generated documentation #1752
Description
Activity
🔍 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 = <Logger slack_sdk.oauth.installation_store.file (WARNING)>)</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 = <Logger slack_sdk.oauth.installation_store.file (WARNING)>)</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 = <Logger slack_sdk.oauth.installation_store.file (WARNING)>)</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 = <Logger slack_sdk.oauth.installation_store.file (WARNING)>)</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 = <Logger slack_sdk.oauth.state_store.file (WARNING)>)</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 = <Logger slack_sdk.oauth.state_store.file (WARNING)>)</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 = <Logger slack_sdk.oauth.state_store.file (WARNING)>)</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 = <Logger slack_sdk.oauth.state_store.file (WARNING)>)</span> </code></dt> <dd> <details class="source">
🔗 https://github.com/slackapi/python-slack-sdk/actions/runs/18182991000/job/51762301843
- linked a pull request that will close this issuedocs(oauth): use a variable "base_dir" home path for file stores #1760
on Oct 2, 2025
The generated documentation includes the user path of the system that generated the docs. We should replace this with a placeholder, if possible.
The issue dates back to May 2022 and it's not something that requires an immediate fix.
Originally discovered in #1751 (comment).
The page URLs
Example:
python-slack-sdk/docs/api-docs/slack_sdk/oauth/installation_store/index.html
Line 347 in e4df183
Requirements
Please read the Contributing guidelines and Code of Conduct before creating this issue or pull request. By submitting, you are agreeing to those rules.