search

Qiskit / qiskit-metapackage

Qiskit is an open-source SDK for working with quantum computers at the level of circuits, algorithms, and application modules.
https://qiskit.org
Apache License 2.0
3.03k stars 753 forks source link

Fix URLs used in stable docs deploys #1744

Closed Eric-Arellano closed 1 year ago

Eric-Arellano commented 1 year ago

I missed this in https://github.com/Qiskit/qiskit-metapackage/pull/1740. We renamed the option from content_prefix to docs_url_prefix.

Eric-Arellano commented 1 year ago

Seems odd to me to have this inconsistency in where the documentation prefix is defined ("as an input to sphinx-build" seemed more logical than "universal conf file" to me, since it's inherently tied to one particular deployment)

I'd be fine with either way.

The important detail is that qiskit_sphinx_theme will error if versions or translations are used and docs_url_prefix isn't set. So, I suppose then it would be safer to not set it in conf.py because it forces every call site of sphinx-build to reason about it, rather than not realizing they're using the default.