Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make API dev docs images deterministic #2517

Open
Eric-Arellano opened this issue Dec 20, 2024 · 0 comments
Open

Make API dev docs images deterministic #2517

Eric-Arellano opened this issue Dec 20, 2024 · 0 comments

Comments

@Eric-Arellano
Copy link
Collaborator

Eric-Arellano commented Dec 20, 2024

I'm reading that binary files are particularly bad for Git repo size. Beyond Git repo size, the diff is annoying that ever time we generate dev API docs, we have unrelated image changes, like #2509.

So, see if we can make the images deterministic, even a few of them. We're not worried about changes resulting from when changes are made to the docs themselves, such as indexes shifting; the goal is that generating the same docs stays the same.

I'm not sure the particular ways to fix things, like the snippets to use. However, Qiskit tests often use techniques like setting the seed (for random number generation) to be deterministic. You can test if your fix worked by re-generating the Sphinx docs in the Qiskit and Runtime repositories with tox -e docs-clean; tox -e docs.

Update Jan 10, 2025: this is less urgent because of AVIF images making images ~10% the size. However, it's still good to fix.

@Eric-Arellano Eric-Arellano added infra 🏗️ needs triage 🤔 this issue needs to be prioritized by the docs team labels Dec 20, 2024
@abbycross abbycross assigned abbycross and kaelynj and unassigned abbycross Jan 16, 2025
@abbycross abbycross removed the needs triage 🤔 this issue needs to be prioritized by the docs team label Jan 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: No status
Development

No branches or pull requests

3 participants