Skip to content

Conversation

zimeg
Copy link
Member

@zimeg zimeg commented Sep 26, 2025

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.

@zimeg zimeg self-assigned this Sep 26, 2025
@zimeg zimeg added docs Improvements or additions to documentation dependencies Pull requests that update a dependency file labels Sep 26, 2025
@zimeg zimeg changed the title build: install dependencies needed to autogenerate documentation build: install dependencies needed to autogenerate reference docs Sep 26, 2025
Copy link

codecov bot commented Sep 26, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.00%. Comparing base (ef3e178) to head (d50e952).
⚠️ Report is 1 commits behind head on main.
✅ All tests successful. No failed tests found.

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.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@WilliamBergamin WilliamBergamin left a comment

Choose a reason for hiding this comment

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

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

Copy link
Member

@mwbrooks mwbrooks left a comment

Choose a reason for hiding this comment

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

✅ Nice, thanks for making this more maintainer friendly!

@zimeg
Copy link
Member Author

zimeg commented Sep 30, 2025

@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 🎁

@zimeg zimeg enabled auto-merge (squash) September 30, 2025 18:46
@zimeg zimeg merged commit 9fa6e86 into main Sep 30, 2025
13 checks passed
@zimeg zimeg deleted the zimeg-docs-autogenerated-dependencies branch September 30, 2025 18:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants