search

Qiskit / qiskit-tutorials

A collection of Jupyter notebooks showing how to use the Qiskit SDK
Apache License 2.0
2.32k stars 1.29k forks source link

Switch to using Tox #1459

Closed Eric-Arellano closed 1 year ago

Eric-Arellano commented 1 year ago

Summary

Previously, there was no standardized way to build the docs locally. While Tox isn't perfect, it aligns us with the rest of the Qiskit ecosystem.

Switching to Tox is important here because it de-duplicates our requirements, which were specified both in requirements-dev.txt and again in azure-pipelines.yaml.

Details and comments

This also fixes two Sphinx warnings due to bad config in conf.py.

I couldn't actually get NBSphinx to work on my mac due to import errors. But this is still some forward progress, so I put up the PR. CI at least will now use tox, and continue to produce a zip of the docs that CI users can inspect.

review-notebook-app[bot] commented 1 year ago

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.

Powered by ReviewNB

HuangJunye commented 1 year ago

You mentioned that nbsphinx is not working on your mac. Does it mean that you can't make a successful local build using tox on your mac?

Eric-Arellano commented 1 year ago

Does it mean that you can't make a successful local build using tox on your mac?

Exactly. But I time-boxed trying to figure this out—there are a few other higher priorities I'm focused on. The main reason I'm cleaning up this repo is to unblock enabling -W in qiskit-metapackage, which is blocked by enabling -W in this repo.

Some forward progress is better than none. While I couldn't get local to work on my mac, CI at least still works.