◐ Shell
clean mode source ↗

build: install dependencies needed to autogenerate reference docs by zimeg · Pull Request #1377 · slackapi/bolt-python

Summary

This PR adds pip installations to the "generate_api_docs.sh" script to make sure all required dependencies are installed in a virtual environment when generating reference - in particular the adapter and async reference!

Testing

Use a new virtual environment to generate the docs:

$ python -m venv .venv
$ source .venv/bin/activate
$ ./scripts/generate_api_docs.sh  # Regenerate the docs!
$ ./scripts/uninstall_all.sh
$ ./scripts/generate_api_docs.sh  # Error without dependencies

Category

  • Document pages under /docs
  • Others

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.

  • 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.