diff --git a/docs_guide/conf.py b/docs_guide/conf.py index bcaf9dcc..e359f8c7 100644 --- a/docs_guide/conf.py +++ b/docs_guide/conf.py @@ -26,6 +26,6 @@ intersphinx_mapping = { "sphinx": ("https://www.sphinx-doc.org/en/master/", None), - "qiskit": ("https://qiskit.org/documentation/", None), - "qiskit-ibm-runtime": ("https://qiskit.org/ecosystem/ibm-runtime/", None), + "qiskit": ("https://docs.quantum.ibm.com/api/qiskit/", None), + "qiskit-ibm-runtime": ("https://docs.quantum.ibm.com/api/qiskit-ibm-runtime/", None), } diff --git a/docs_guide/requirements-extra.txt b/docs_guide/requirements-extra.txt index c6ecef87..14172538 100644 --- a/docs_guide/requirements-extra.txt +++ b/docs_guide/requirements-extra.txt @@ -1,4 +1,4 @@ # this file contains extra requirements for building the docs guide in addition to `requirements-dev.txt` -qiskit-terra +qiskit~=1.0 pylatexenc sphinx_toolbox diff --git a/docs_guide/sphinx_guide/how_to_add_external_links.rst b/docs_guide/sphinx_guide/how_to_add_external_links.rst index 05f9c2e1..2b1333ce 100644 --- a/docs_guide/sphinx_guide/how_to_add_external_links.rst +++ b/docs_guide/sphinx_guide/how_to_add_external_links.rst @@ -13,11 +13,11 @@ There are two types of files ``.rst`` ========= -In order to link to an external page you have to write ```text of your link `_``. For example, you can link to `Qiskit's page `_ by writing: +In order to link to an external page you have to write ```text of your link `_``. For example, you can link to `IBM Quantum documentation `_ by writing: .. code-block:: text - `Qiskit's page `_ + `IBM Quantum documentation `_ .. note:: @@ -27,11 +27,11 @@ In order to link to an external page you have to write ```text of your link `_ you can write: +If your file is a Jupyter notebook, what you have to write to link to a page is ``[text of your link](your_url)``. If you want to link to `IBM Quantum Documentation `_ you can write: .. code-block:: text - [Qiskit's page](https://qiskit.org/) + [Qiskit's page](https://docs.quantum.ibm.com) .. warning:: diff --git a/docs_guide/sphinx_guide/how_to_cross-reference.rst b/docs_guide/sphinx_guide/how_to_cross-reference.rst index c5491887..e2bdbaf7 100644 --- a/docs_guide/sphinx_guide/how_to_cross-reference.rst +++ b/docs_guide/sphinx_guide/how_to_cross-reference.rst @@ -95,7 +95,7 @@ For example, if you want to add Qiskit's and Sphinx's documentation you can writ .. code-block:: python intersphinx_mapping = { - "qiskit": ("https://qiskit.org/documentation/", None), + "qiskit": ("https://docs.quantum.ibm.com/api/qiskit/", None), "sphinx": ("https://www.sphinx-doc.org/en/master/", None) } diff --git a/docs_guide/sphinx_guide/sphinx.rst b/docs_guide/sphinx_guide/sphinx.rst index be77abb8..e9a241f7 100644 --- a/docs_guide/sphinx_guide/sphinx.rst +++ b/docs_guide/sphinx_guide/sphinx.rst @@ -35,5 +35,4 @@ Sphinx also offers a wide array of extensions that make creating docs much easie Another Sphinx characteristic we use extensively is the ability to customize an HTML theme, so we have our own theme called -`qiskit_sphinx_theme `_, that gives `qiskit.org `_ and any locally built Qiskit docs their -characteristic appearance. \ No newline at end of file +`qiskit_sphinx_theme `_, that gives a consistent theme for projects in the `Qiskit Ecosystem `__. \ No newline at end of file diff --git a/docs_guide/tutorials/tutorials_examples.rst b/docs_guide/tutorials/tutorials_examples.rst index b81aadf3..b6a3c0dd 100644 --- a/docs_guide/tutorials/tutorials_examples.rst +++ b/docs_guide/tutorials/tutorials_examples.rst @@ -8,6 +8,6 @@ examples to create your own tutorials. Qiskit IBM Runtime ================== -* :doc:`qiskit-ibm-runtime:tutorials/grover_with_sampler` -* :doc:`qiskit-ibm-runtime:tutorials/chsh_with_estimator` -* :doc:`qiskit-ibm-runtime:tutorials/vqe_with_estimator` +* https://github.com/Qiskit/qiskit-ibm-runtime/blob/stable/0.16/docs/tutorials/grover_with_sampler.ipynb +* https://github.com/Qiskit/qiskit-ibm-runtime/blob/stable/0.16/docs/tutorials/chsh_with_estimator.ipynb +* https://github.com/Qiskit/qiskit-ibm-runtime/blob/stable/0.16/docs/tutorials/vqe_with_estimator.ipynb diff --git a/pyproject.toml b/pyproject.toml index ea6c8b90..289b2253 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -9,7 +9,7 @@ readme = "README.md" dynamic = ["version"] license = { file = "LICENSE" } -authors = [{ name = "Qiskit Development Team", email = "hello@qiskit.org" }] +authors = [{ name = "Qiskit Development Team", email = "qiskit@us.ibm.com" }] classifiers = [ "Development Status :: 5 - Production/Stable", "Environment :: Web Environment", diff --git a/src/qiskit_sphinx_theme/assets/styles/_layout.scss b/src/qiskit_sphinx_theme/assets/styles/_layout.scss index 1ea66e82..fa358a08 100644 --- a/src/qiskit_sphinx_theme/assets/styles/_layout.scss +++ b/src/qiskit_sphinx_theme/assets/styles/_layout.scss @@ -15,7 +15,7 @@ // doesn't increase the entry size. It also keeps the page contents fixed at 46em. // // Instead, we always keep the side bars the same size, and we expand the main page -// contents. This is a better use of screen real estate and is more consistent with qiskit.org. +// contents. This is a better use of screen real estate. // // But, we only expand the main contents up to 60em because best practices recommend not having // prose-heavy sites spread content over too long: diff --git a/src/qiskit_sphinx_theme/assets/styles/_tables.scss b/src/qiskit_sphinx_theme/assets/styles/_tables.scss index 7ccb2a1f..1a69f95e 100644 --- a/src/qiskit_sphinx_theme/assets/styles/_tables.scss +++ b/src/qiskit_sphinx_theme/assets/styles/_tables.scss @@ -12,7 +12,7 @@ */ body { - // Use the same table header color as qiskit.org. + // Use the same table header color previously used on qiskit.org. --color-table-header-background: #dde1e6; } diff --git a/src/qiskit_sphinx_theme/theme/qiskit-sphinx-theme/custom_templates/sidebar_brand.html b/src/qiskit_sphinx_theme/theme/qiskit-sphinx-theme/custom_templates/sidebar_brand.html index 64c8b335..820e1a81 100644 --- a/src/qiskit_sphinx_theme/theme/qiskit-sphinx-theme/custom_templates/sidebar_brand.html +++ b/src/qiskit_sphinx_theme/theme/qiskit-sphinx-theme/custom_templates/sidebar_brand.html @@ -6,7 +6,7 @@ {#- We default to showing a Qiskit Ecosystem logo -#} {%- if not logo_url and not theme_light_logo and not theme_dark_logo and not theme_disable_ecosystem_logo -%}
- +