build: install dependencies needed to autogenerate reference docs#1377
build: install dependencies needed to autogenerate reference docs#1377
Conversation
zimeg
requested review from
WilliamBergamin,
lukegalbraithrussell,
mwbrooks and
srtaalej
zimeg
added
docs
zimeg
changed the title
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1377 +/- ##
=======================================
Coverage 91.00% 91.00%
=======================================
Files 222 222
Lines 7512 7512
=======================================
Hits 6836 6836
Misses 676 676 ☔ View full report in Codecov by Sentry. |
WilliamBergamin
left a comment
WilliamBergamin
left a comment
There was a problem hiding this comment.
Nice 💯
I've probably always ran this script after running scripts/install_all_and_run_tests.sh and never noticed it missed to install some dependencies
mwbrooks
left a comment
mwbrooks
left a comment
There was a problem hiding this comment.
✅ Nice, thanks for making this more maintainer friendly!
|
@WilliamBergamin @mwbrooks Thank y'all both so much! I think I had a similar setup with dependencies existing before releasing things beforehand, but recent testing has caught edges for me... Let's merge this for improved releases going forward 🎁 |
3 participants
Summary
This PR adds
pipinstallations 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:
Category
/docsRequirements
Please read the Contributing guidelines and Code of Conduct before creating this issue or pull request. By submitting, you are agreeing to those rules.
./scripts/install_all_and_run_tests.shafter making the changes.