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

Remove Pulse library URL renaming in docs #13107

Merged
merged 1 commit into from
Sep 11, 2024

Conversation

Eric-Arellano
Copy link
Collaborator

The workaround from #9748 is no longer necessary because there is no conflict with capitalization. So, we can go back to using the default URL for these classes, such as qiskit.pulse.library.Constant.

We will set up redirects in docs.quantum.ibm.com for this URL change.

@Eric-Arellano Eric-Arellano added documentation Something is not clear or an error documentation Changelog: None Do not include in changelog labels Sep 6, 2024
@Eric-Arellano Eric-Arellano requested a review from a team as a code owner September 6, 2024 20:50
@qiskit-bot
Copy link
Collaborator

One or more of the following people are relevant to this code:

@Eric-Arellano
Copy link
Collaborator Author

If you're willing to cherry-pick to 1.2, that would help the docs team so that the 1.3 release is less stressful. No big deal otherwise.

@mtreinish mtreinish added the stable backport potential The bug might be minimal and/or import enough to be port to stable label Sep 6, 2024
@coveralls
Copy link

Pull Request Test Coverage Report for Build 10745064909

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 21 unchanged lines in 2 files lost coverage.
  • Overall coverage decreased (-0.002%) to 89.13%

Files with Coverage Reduction New Missed Lines %
crates/qasm2/src/lex.rs 3 92.48%
crates/qasm2/src/parse.rs 18 96.69%
Totals Coverage Status
Change from base Build 10742451788: -0.002%
Covered Lines: 72717
Relevant Lines: 81585

💛 - Coveralls

@Eric-Arellano
Copy link
Collaborator Author

Bump

@Eric-Arellano Eric-Arellano added this to the 1.2.1 milestone Sep 10, 2024
@Cryoris
Copy link
Contributor

Cryoris commented Sep 11, 2024

I don't have a great history of success building the docs locally (on my Mac) but running it on this branch I'm getting

/Users/jul/Qiskit/qiskit/docs/stubs/qiskit.pulse.library.Constant_class.rst.rst: WARNING: document isn't included in any toctree
/Users/jul/Qiskit/qiskit/docs/stubs/qiskit.pulse.library.Cos_class.rst.rst: WARNING: document isn't included in any toctree
/Users/jul/Qiskit/qiskit/docs/stubs/qiskit.pulse.library.Drag_class.rst.rst: WARNING: document isn't included in any toctree
/Users/jul/Qiskit/qiskit/docs/stubs/qiskit.pulse.library.Gaussian_class.rst.rst: WARNING: document isn't included in any toctree
/Users/jul/Qiskit/qiskit/docs/stubs/qiskit.pulse.library.Sawtooth_class.rst.rst: WARNING: document isn't included in any toctree
/Users/jul/Qiskit/qiskit/docs/stubs/qiskit.pulse.library.Sech_fun.rst.rst: WARNING: document isn't included in any toctree
/Users/jul/Qiskit/qiskit/docs/stubs/qiskit.pulse.library.Sin_class.rst.rst: WARNING: document isn't included in any toctree
/Users/jul/Qiskit/qiskit/docs/stubs/qiskit.pulse.library.Square_fun.rst.rst: WARNING: document isn't included in any toctree

Did it work on your Mac?

@jakelishman
Copy link
Member

Julien: try tox -e docs-clean,docs and see if it's successful.

Copy link
Contributor

@ElePT ElePT left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have managed to successfully build the docs in MacOS with tox -e docs-clean,docs, @Cryoris. Preview looks good and links work.

Screenshot 2024-09-11 at 14 42 08
Screenshot 2024-09-11 at 14 42 21

@Cryoris Cryoris added this pull request to the merge queue Sep 11, 2024
Merged via the queue into Qiskit:main with commit c5e9f8a Sep 11, 2024
15 checks passed
mergify bot pushed a commit that referenced this pull request Sep 11, 2024
@Eric-Arellano Eric-Arellano deleted the EA/rm-pulse-library-renaming branch September 11, 2024 15:02
github-merge-queue bot pushed a commit that referenced this pull request Sep 11, 2024
(cherry picked from commit c5e9f8a)

Co-authored-by: Eric Arellano <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Changelog: None Do not include in changelog documentation Something is not clear or an error documentation stable backport potential The bug might be minimal and/or import enough to be port to stable
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants