Qiskit / qiskit_sphinx_theme

A Sphinx theme and documentation guidelines for Qiskit and Qiskit Ecosystem projects
https://qisk.it/docs-guide
Apache License 2.0
15 stars 29 forks source link

Add visual regression testing for ecosystem theme #477

Closed Eric-Arellano closed 1 year ago

Eric-Arellano commented 1 year ago

Closes https://github.com/Qiskit/qiskit_sphinx_theme/issues/470.

Users can now run npm run test-qiskit (same as before) or npm run test-ecosystem. That will

  1. build the appropriate docs,
  2. start up its server, and
  3. run the relevant tests.

We intentionally don't have a command to run all tests at once. Playwright can only auto-start one server, so we need a distinct call to Playwright per project.

Follow up PRs will add actual meaningful tests.

FYI: uses Docker base images

We now have Dockerfile.base, Dockerfile.qiskit, and Dockerfile.ecosystem. This setup is common in Docker and allows us to DRY things (don't repeat yourself).