Skip to content

Add /api-docs/slack_bolt/ generation#263

Merged
seratch merged 2 commits intoslackapi:mainfrom
seratch:api-docs-generation
Mar 24, 2021
Merged

Add /api-docs/slack_bolt/ generation#263
seratch merged 2 commits intoslackapi:mainfrom
seratch:api-docs-generation

Conversation

@seratch
Copy link
Contributor

@seratch seratch commented Mar 19, 2021

This pull request updates the docstring for API document generation. The changes in this PR are:

The live preview is available at:

This pull request partially resolves #128 but we still need some additional information as with https://slack.dev/bolt-js/reference

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

  • slack_bolt.App and/or its core components
  • slack_bolt.async_app.AsyncApp and/or its core components
  • Adapters in slack_bolt.adapter
  • Document pages under /docs
  • Others

Requirements (place an x in each [ ])

Please read the Contributing guidelines and Code of Conduct before creating this issue or pull request. By submitting, you are agreeing to those rules.

  • 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 ./scripts/install_all_and_run_tests.sh after making the changes.

@seratch seratch added the docs Improvements or additions to documentation label Mar 19, 2021
@seratch seratch added this to the 1.5.0 milestone Mar 19, 2021
@seratch seratch self-assigned this Mar 19, 2021
@codecov
Copy link

codecov bot commented Mar 19, 2021

Codecov Report

Merging #263 (8d84786) into main (1282934) will not change coverage.
The diff coverage is n/a.

❗ Current head 8d84786 differs from pull request most recent head af86eff. Consider uploading reports for the commit af86eff to get more accurate results
Impacted file tree graph

@@           Coverage Diff           @@
##             main     #263   +/-   ##
=======================================
  Coverage   91.25%   91.25%           
=======================================
  Files         160      160           
  Lines        4983     4983           
=======================================
  Hits         4547     4547           
  Misses        436      436           
Impacted Files Coverage Δ
slack_bolt/__init__.py 100.00% <ø> (ø)
slack_bolt/app/__init__.py 100.00% <ø> (ø)
slack_bolt/app/app.py 86.44% <ø> (ø)
slack_bolt/app/async_app.py 94.18% <ø> (ø)
slack_bolt/app/async_server.py 48.83% <ø> (ø)
slack_bolt/async_app.py 100.00% <ø> (ø)
slack_bolt/authorization/__init__.py 100.00% <ø> (ø)
slack_bolt/authorization/async_authorize_args.py 100.00% <ø> (ø)
slack_bolt/authorization/authorize_args.py 100.00% <ø> (ø)
slack_bolt/authorization/authorize_result.py 100.00% <ø> (ø)
... and 118 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 1282934...af86eff. Read the comment docs.

@@ -1,3 +1,93 @@
"""
## Welcome to Bolt for Python API Document!
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We will simplify this page document to just have links to key packages/classes

@seratch seratch force-pushed the api-docs-generation branch from bd206bf to af86eff Compare March 24, 2021 12:23
@seratch seratch merged commit 11e202a into slackapi:main Mar 24, 2021
@seratch seratch deleted the api-docs-generation branch March 24, 2021 12:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add reference page in documents

1 participant