-
Notifications
You must be signed in to change notification settings - Fork 288
Comparing changes
Open a pull request
base repository: slackapi/bolt-python
base: main
head repository: slackapi/bolt-python
compare: md-reference
- 13 commits
- 497 files changed
- 2 contributors
Commits on Aug 13, 2026
-
docs: add Markdown code fences to docstrings
Wrap inline code examples in docstrings with ```python fences so the Markdown API reference renders them as highlighted code blocks instead of flat prose. Changes are docstring-only; no code behavior is affected. Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
Configuration menu - View commit details
-
Copy full SHA for 01015a2 - Browse repository at this point
Copy the full SHA 01015a2View commit details -
docs: migrate API reference from HTML (pdoc3) to Markdown (pydoc-mark…
…down) Replace the pdoc3 HTML generator with pydoc-markdown so the API reference is emitted as Markdown for docs.slack.dev/Docusaurus. - Rewrite generate_api_docs.sh to drive the new Markdown pipeline. - Add generate_api_docs.py, which: - inlines re-exported classes/functions so adapter pages show their handler inline (matching pdoc3's behavior); - adds OrderedGoogleProcessor to keep fenced code blocks in their original position (the stock GoogleProcessor relocates a code block that precedes a section keyword to after the prose); - replaces pydoc-markdown's escape_except_blockquotes, which corrupts docstrings with >10 code spans by duplicating a code block into later spans (BLOCKQUOTE_TOKEN prefix collision). - Regenerate docs/reference as Markdown (removes the old HTML tree). - Point the sidebar "Reference" link at the new Markdown path. Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>Configuration menu - View commit details
-
Copy full SHA for 67812bc - Browse repository at this point
Copy the full SHA 67812bcView commit details -
docs: serve package reference pages at folder URLs
Rename each generated package __init__.md to index.md and rewrite the generated sidebar.json edges to match. The docusaurus renderer emits a package's docs as <pkg>/__init__.md, whose route is .../<pkg>/__init__ -- nothing resolves at the bare .../<pkg>/ URL that the sidebar's Reference link (.../reference/slack_bolt/) targets. Docusaurus serves index.md at the folder URL, so this makes that link resolve instead of 404. Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
Configuration menu - View commit details
-
Copy full SHA for 2266bf2 - Browse repository at this point
Copy the full SHA 2266bf2View commit details -
Configuration menu - View commit details
-
Copy full SHA for 23874b0 - Browse repository at this point
Copy the full SHA 23874b0View commit details -
docs: fence App.start() example and target docs/english/reference
The App.start() docstring had an indented (unfenced) code example whose '#' comment lines rendered as Markdown H1 headers in the Markdown output. Wrap it in a ```python fence. This propagates to all 24 pages that inline App via re-export. Also point the generator at docs/english/reference (the reference tree's location) instead of docs/reference. Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
Configuration menu - View commit details
-
Copy full SHA for de6d47e - Browse repository at this point
Copy the full SHA de6d47eView commit details -
docs: embed reference tree into _sidebar.json
The docs site imports docs/english/_sidebar.json and filters it; it does not read the generated reference/sidebar.json. Replace the external "Reference" link with the generated category tree, prefixing doc IDs with tools/bolt-python/ so they resolve against the docs root. The generator now does this automatically (_sync_reference_sidebar) so the sidebar stays in sync on every regeneration. Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
Configuration menu - View commit details
-
Copy full SHA for 51128e2 - Browse repository at this point
Copy the full SHA 51128e2View commit details
Commits on Aug 14, 2026
-
Configuration menu - View commit details
-
Copy full SHA for c6960fc - Browse repository at this point
Copy the full SHA c6960fcView commit details -
Configuration menu - View commit details
-
Copy full SHA for 2b95612 - Browse repository at this point
Copy the full SHA 2b95612View commit details -
Configuration menu - View commit details
-
Copy full SHA for 44bafeb - Browse repository at this point
Copy the full SHA 44bafebView commit details -
Configuration menu - View commit details
-
Copy full SHA for da71715 - Browse repository at this point
Copy the full SHA da71715View commit details -
Configuration menu - View commit details
-
Copy full SHA for 7bf50da - Browse repository at this point
Copy the full SHA 7bf50daView commit details -
Configuration menu - View commit details
-
Copy full SHA for ab7e690 - Browse repository at this point
Copy the full SHA ab7e690View commit details -
Configuration menu - View commit details
-
Copy full SHA for 24fe29c - Browse repository at this point
Copy the full SHA 24fe29cView commit details
This comparison is taking too long to generate.
Unfortunately it looks like we can’t render this comparison for you right now. It might be too big, or there might be something weird with your repository.
You can try running this command locally to see the comparison on your machine:
git diff main...md-reference