Remove sphinx.ext.autosummary from lib/docs/conf.py

[ns-rse]

Hopefully this closes #239 and the API duplication will no longer occur.

[codecov]

Codecov Report

Patch and project coverage have no change.

Comparison is base (21670ab) 69.37% compared to head (d6630ce) 69.37%.
Report is 2 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff           @@
##           master     #243   +/-   ##
=======================================
  Coverage   69.37%   69.37%           
=======================================
  Files          11       11           
  Lines         493      493           
=======================================
  Hits          342      342           
  Misses        151      151           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[ns-rse]

Hmm, I think I may have been distracted and failed to put out a PR to remove the duplicate API. End-to-end tests are failing, so I merged origin/main into this branch as I recall you saying it was something you would fix @TheLostLambda but I think that may still be pending?

[TheLostLambda]

@ns-rse I'll try to sort out what the CI testing is upset about. In the meantime, can we delete lib/docs/api.rst?

[ns-rse]

@TheLostLambda thanks, wasn't paying attention, now removed.

[TheLostLambda]

Let's hope this helps!

[ns-rse]

👍 What is the difference between pnpm and pnpx?

(I know little to nothing about these frameworks!).

[TheLostLambda]

The normal JS package manager is pnpm (and it allows you to run programs installed locally in the node_modules folder), and pnpx is a version that executes a remote package as a command. It installs the latest version on the fly, then runs the program.

The issue with the CI tests was that a new version of Playwright was released, so pnpx started pulling that new version, and it installed versions of the test browsers that were incompatible with the version of Playwright in our package.json. It looks like, by changing out pnpx for pnpm exec, you can run the locally installed playwright that respects the semantic versioning requirements set in the package.json.

That's how I came to understand things, anyways! Half of the CI process was using a newer version of Playwright that had been released, but the testing phase (pnpm test) used our older, locked version, so things broke.