Skip to content

Add v3 doc#989

Draft
habara-k wants to merge 2 commits intomasterfrom
add-v3-doc
Draft

Add v3 doc#989
habara-k wants to merge 2 commits intomasterfrom
add-v3-doc

Conversation

@habara-k
Copy link
Copy Markdown
Contributor

@habara-k habara-k commented Apr 14, 2026

Motivation

The v3 SDK modules (linebot.v3.messaging, linebot.v3.audience, etc.) have no Sphinx documentation generated, despite the v2 linebot modules being documented. Additionally, the
OpenAPI generator's async template contains incorrect docstrings claiming "This method makes a synchronous HTTP request by default" in AsyncMessagingApi and similar async classes.

What's changed

Sphinx docs for v3

  • Add docs/source/linebot.v3.rst and 9 subpackage .rst files (messaging, audience, insight, liff, module, moduleattach, oauth, shop, webhooks)
  • Add linebot.v3 to docs/source/index.rst toctree
  • Both sync and async API classes are documented (e.g., MessagingApi and AsyncMessagingApi)

Template fixes (generator/.../python-nextgen-custom-client/)

  • asyncio/async_api.mustache:
  • Remove incorrect "This method makes a synchronous HTTP request by default" text
  • Remove # noqa: E501 from docstring lines (kept on code lines)
  • Remove operationId fallback from docstring first line
  • Add blank line between description and :param field list to fix reST parsing warnings
  • api.mustache:
  • Remove # noqa: E501 from docstring lines
  • Remove operationId fallback from docstring first line

Regenerated API files (23 files)

All linebot/v3/*/api/*.py files regenerated with cleaned-up docstrings.

How to review

Build and preview locally:

cd docs && make clean && make html && open build/html/index.html

All 8 warnings are pre-existing v2 issues. Zero new warnings from v3 docs.

@habara-k habara-k self-assigned this Apr 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant