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

More explicitly direct people to run notebooks with tox #1239

Closed
Tracked by #1326
Eric-Arellano opened this issue Apr 24, 2024 · 2 comments · Fixed by #1365
Closed
Tracked by #1326

More explicitly direct people to run notebooks with tox #1239

Eric-Arellano opened this issue Apr 24, 2024 · 2 comments · Fixed by #1365

Comments

@Eric-Arellano
Copy link
Collaborator

The majority of our authors use VSCode, which will by default generate PNGs rather than the superior SVGs. We should tell them how to set up VSCode to use SVGs instead.

This is probably a global config you set for Jupyter?

This change would help avoid the need for #1226.

@frankharkins
Copy link
Member

frankharkins commented Apr 25, 2024

I'm happy to add the documentation, but I'm not sure how effective it is to keep adding things like this to our READMEs. They already contain a lot of information, only some of which is relevant to each contributor, and I doubt contributors review them regularly for updates.

I think ideally we'd have a unified workflow which everyone follows, then we could do things like switch to SVGs, update packages, etc. without needing contributors to set their config or remember to run another script. This is kinda what I'd hoped for with tox, but it doesn't seem to have stuck. Maybe we should chat to the contributors and work out if there's a better way to integrate it.

A potential solution is to incorporate something like the "auto execute" function from #601. We know for a fact all contributors go through PRs, and it makes running tox a one-step process with no local configuration necessary.

I do still think it's worth documenting processes such as how to deploy tutorials; contributors will seek those out when they need them. I just think it's kinda futile adding rules and guidelines.

@Eric-Arellano Eric-Arellano changed the title Document how to generate SVGs in Jupyter notebooks Document how to generate SVGs in Jupyter notebooks? Apr 25, 2024
@Eric-Arellano Eric-Arellano changed the title Document how to generate SVGs in Jupyter notebooks? More explicitly direct people to run notebooks with tox? Apr 26, 2024
@Eric-Arellano
Copy link
Collaborator Author

In the backlog sweep, we agreed with you, Frank. Rather than telling people how to better configure VSCode, we should be directing them to use tox for the final run. It's fine to use VSCode/Jupyter when iterating, but we want tox for the final execution so that we are all using a consistent environment.

So this issue is now revisiting the README to see if we can make this expectation more clear.

@Eric-Arellano Eric-Arellano changed the title More explicitly direct people to run notebooks with tox? More explicitly direct people to run notebooks with tox Apr 26, 2024
github-merge-queue bot pushed a commit that referenced this issue May 14, 2024
Closes #1239

---------

Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
frankharkins added a commit to frankharkins/documentation that referenced this issue Jul 22, 2024
)

Closes Qiskit#1239

---------

Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
@javabster javabster removed this from Docs Planning Feb 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants