Skip to content

Add /api-docs in the website#983

Merged
seratch merged 1 commit intoslackapi:mainfrom
seratch:enable-api-docs
Mar 24, 2021
Merged

Add /api-docs in the website#983
seratch merged 1 commit intoslackapi:mainfrom
seratch:enable-api-docs

Conversation

@seratch
Copy link
Contributor

@seratch seratch commented Mar 24, 2021

Summary

This pull request adds the script to generate python documents. After merging this, I will publish the initial version of the documents. Resolves #980

Category (place an x in each of the [ ])

  • slack_sdk.web.WebClient (sync/async) (Web API client)
  • slack_sdk.webhook.WebhookClient (sync/async) (Incoming Webhook, response_url sender)
  • slack_sdk.models (UI component builders)
  • slack_sdk.oauth (OAuth Flow Utilities)
  • slack_sdk.socket_mode (Socket Mode client)
  • slack_sdk.audit_logs (Audit Logs API client)
  • slack_sdk.scim (SCIM API client)
  • slack_sdk.rtm (RTM client)
  • slack_sdk.signature (Request Signature Verifier)
  • /docs-src (Documents, have you run ./docs.sh?)
  • /docs-src-v2 (Documents, have you run ./docs-v2.sh?)
  • /tutorial (PythOnBoardingBot tutorial)
  • tests/integration_tests (Automated tests for this library)

Requirements (place an x in each [ ])

  • I've read and understood the Contributing Guidelines and have done my best effort to follow them.
  • I've read and agree to the Code of Conduct.
  • I've run python setup.py validate after making the changes.

@seratch seratch added docs M-T: Documentation work only Version: 3x labels Mar 24, 2021
@codecov
Copy link

codecov bot commented Mar 24, 2021

Codecov Report

Merging #983 (22a10f3) into main (200a271) will decrease coverage by 0.01%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #983      +/-   ##
==========================================
- Coverage   87.25%   87.24%   -0.02%     
==========================================
  Files          94       94              
  Lines        8543     8543              
==========================================
- Hits         7454     7453       -1     
- Misses       1089     1090       +1     
Impacted Files Coverage Δ
slack_sdk/__init__.py 100.00% <ø> (ø)
slack_sdk/aiohttp_version_checker.py 90.90% <ø> (ø)
slack_sdk/audit_logs/__init__.py 100.00% <ø> (ø)
slack_sdk/audit_logs/v1/async_client.py 88.75% <ø> (ø)
slack_sdk/audit_logs/v1/client.py 77.90% <ø> (ø)
slack_sdk/errors/__init__.py 100.00% <ø> (ø)
slack_sdk/models/__init__.py 100.00% <ø> (ø)
slack_sdk/oauth/__init__.py 100.00% <ø> (ø)
...sdk/oauth/installation_store/installation_store.py 71.42% <ø> (ø)
slack_sdk/oauth/state_store/__init__.py 100.00% <ø> (ø)
... and 18 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 200a271...22a10f3. Read the comment docs.

@seratch seratch merged commit 1e2d144 into slackapi:main Mar 24, 2021
@seratch seratch deleted the enable-api-docs branch March 24, 2021 07:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs M-T: Documentation work only Version: 3x

Projects

None yet

Development

Successfully merging this pull request may close these issues.

API document hosting

1 participant