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

Update docs build artifact version #361

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/docs_stable.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ on:

jobs:
deploy:
if: github.repository_owner == 'Qiskit-Extensions'
if: github.repository_owner == 'Qiskit-Community'
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ jobs:
sudo apt-get install graphviz pandoc
- name: Build Docs
run: tox -edocs
- uses: actions/upload-artifact@v2
- uses: actions/upload-artifact@v4
with:
name: html_docs
path: docs/_build/html
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ as:
fixes:
- |
Fixes a race condition in the function ``foo()``. Refer to
`#12345 <https://github.com/Qiskit-Extensions/qiskit-dynamics/issues/12345>` for more
`#12345 <https://github.com/Qiskit-Community/qiskit-dynamics/issues/12345>` for more
details.
```

Expand Down
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ automatic differentiation, and GPU execution, and therefore is well-suited to ta
repeated evaluation of functions with different parameters; E.g. simulating a model of a quantum
system over a range of parameter values, or optimizing the parameters of control sequence.

Reference documentation may be found [here](https://qiskit-extensions.github.io/qiskit-dynamics/), including
[tutorials](https://qiskit-extensions.github.io/qiskit-dynamics/tutorials/index.html),
[user guide](https://qiskit-extensions.github.io/qiskit-dynamics/userguide/index.html),
[API reference](https://qiskit-extensions.github.io/qiskit-dynamics/apidocs/index.html), and
[Discussions](https://qiskit-extensions.github.io/qiskit-dynamics/discussions/index.html).
Reference documentation may be found [here](https://qiskit-community.github.io/qiskit-dynamics/), including
[tutorials](https://qiskit-community.github.io/qiskit-dynamics/tutorials/index.html),
[user guide](https://qiskit-community.github.io/qiskit-dynamics/userguide/index.html),
[API reference](https://qiskit-community.github.io/qiskit-dynamics/apidocs/index.html), and
[Discussions](https://qiskit-community.github.io/qiskit-dynamics/discussions/index.html).

## Installation

Expand All @@ -51,7 +51,7 @@ If you'd like to contribute to Qiskit Dynamics, please take a look at our
[contribution guidelines](CONTRIBUTING.md). This project adheres to Qiskit's
[code of conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.

We use [GitHub issues](https://github.com/Qiskit-Extensions/qiskit-dynamics/issues) for tracking
We use [GitHub issues](https://github.com/Qiskit-Community/qiskit-dynamics/issues) for tracking
requests and bugs. Please [join the Qiskit Slack community](https://qisk.it/join-slack) and use our
[#qiskit-dynamics](https://qiskit.slack.com/archives/C03E7UVCDEV) channel for discussion and simple
questions. For questions that are more suited for a forum we use the Qiskit tag in the
Expand All @@ -60,10 +60,10 @@ questions. For questions that are more suited for a forum we use the Qiskit tag
## Authors and Citation

Qiskit Dynamics is the work of
[many people](https://github.com/Qiskit-Extensions/qiskit-dynamics/graphs/contributors) who
[many people](https://github.com/Qiskit-Community/qiskit-dynamics/graphs/contributors) who
contribute to the project at different levels. If you use Qiskit Dynamics, please cite our
[paper](https://joss.theoj.org/papers/10.21105/joss.05853) as per the included
[BibTeX file](https://github.com/Qiskit-Extensions/qiskit-dynamics/blob/main/CITATION.bib).
[BibTeX file](https://github.com/Qiskit-Community/qiskit-dynamics/blob/main/CITATION.bib).

## License

Expand Down
4 changes: 2 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,8 @@
autoclass_content = "both"
intersphinx_mapping = {
"qiskit": ("https://docs.quantum.ibm.com/api/qiskit", None),
"qiskit_experiments": ("https://qiskit-extensions.github.io/qiskit-experiments/", None),
"arraylias": ("https://qiskit-extensions.github.io/arraylias/", None)
"qiskit_experiments": ("https://qiskit-community.github.io/qiskit-experiments/", None),
"arraylias": ("https://qiskit-community.github.io/arraylias/", None)
}

# nbsphinx options (for tutorials)
Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ just-in-time compilation, automatic differentiation, and GPU execution of Qiskit
This package is still in the early stages of development and it is very likely
that there will be breaking API changes in future releases.
If you encounter any bugs please open an issue on
`Github <https://github.com/Qiskit-Extensions/qiskit-dynamics/issues>`_
`Github <https://github.com/Qiskit-Community/qiskit-dynamics/issues>`_


.. toctree::
Expand Down
6 changes: 3 additions & 3 deletions docs/userguide/how_to_use_different_array_libraries.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ and types. A user can choose to use either NumPy or JAX to define their models,
Qiskit Dynamics will execute as if the array operations had been natively written in either library.
Additionally, a user can specify that the operators in a model be stored in sparse types offered by
SciPy or JAX (see :ref:`configuring simulations for performance <configuring simulations>`).
Internally, Qiskit Dynamics utilizes `Arraylias <https://qiskit-extensions.github.io/arraylias/>`_
Internally, Qiskit Dynamics utilizes `Arraylias <https://qiskit-community.github.io/arraylias/>`_
to dispatch computations on different array types to the appropriate library function.

This guide addresses the following topics:
Expand Down Expand Up @@ -78,7 +78,7 @@ JAX transformations can be applied to ``signal_jax``, e.g. just-in-time compilat
-------------------------------------------------------------------

Internally, Qiskit Dynamics uses an extension of the default NumPy and SciPy array libraries offered
by `Arraylias <https://qiskit-extensions.github.io/arraylias/>`_. These can be imported as:
by `Arraylias <https://qiskit-community.github.io/arraylias/>`_. These can be imported as:

.. jupyter-execute::

Expand All @@ -90,7 +90,7 @@ by `Arraylias <https://qiskit-extensions.github.io/arraylias/>`_. These can be i
from qiskit_dynamics import DYNAMICS_SCIPY_ALIAS
from qiskit_dynamics import DYNAMICS_SCIPY

See the `Arraylias documentation <https://qiskit-extensions.github.io/arraylias/>`_ for how the
See the `Arraylias documentation <https://qiskit-community.github.io/arraylias/>`_ for how the
general library aliasing framework works, as well as the Qiskit Dynamics submodule :mod:`.arraylias`
for a description of how the default NumPy and SciPy aliases have been extended for use in this
package.
Expand Down
4 changes: 2 additions & 2 deletions qiskit_dynamics/arraylias/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@
.. currentmodule:: qiskit_dynamics.arraylias

This module contains Qiskit Dynamics-global extensions of the default NumPy and SciPy aliases
provided by `Arraylias <https://qiskit-extensions.github.io/arraylias/>`_. These are used to manage
provided by `Arraylias <https://qiskit-community.github.io/arraylias/>`_. These are used to manage
dispatching of array operations for the different array types supported by Qiskit Dynamics. They
have been configured beyond the `Arraylias <https://qiskit-extensions.github.io/arraylias/>`_
have been configured beyond the `Arraylias <https://qiskit-community.github.io/arraylias/>`_
defaults to additionally support both `JAX <https://jax.readthedocs.io/en/latest/>`_ and SciPy
sparse types. The following table summarizes the registered libraries and respective types.

Expand Down
8 changes: 4 additions & 4 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
description="Qiskit ODE solver",
long_description=README,
long_description_content_type='text/markdown',
url="https://github.com/Qiskit-Extensions/qiskit-dynamics",
url="https://github.com/Qiskit-Community/qiskit-dynamics",
author="Qiskit Development Team",
author_email="[email protected]",
license="Apache 2.0",
Expand All @@ -69,9 +69,9 @@
],
keywords="qiskit sdk quantum",
project_urls={
"Bug Tracker": "https://github.com/Qiskit-Extensions/qiskit-dynamics/issues",
"Source Code": "https://github.com/Qiskit-Extensions/qiskit-dynamics",
"Documentation": "https://qiskit-extensions.github.io/qiskit-dynamics/",
"Bug Tracker": "https://github.com/Qiskit-Community/qiskit-dynamics/issues",
"Source Code": "https://github.com/Qiskit-Community/qiskit-dynamics",
"Documentation": "https://qiskit-community.github.io/qiskit-dynamics/",
},
install_requires=requirements,
include_package_data=True,
Expand Down
Loading