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.

Sign up for GitHub

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

Jump to bottom

Reactive the viewcode extension for docs #11548

Merged
merged 1 commit into from
Jan 15, 2024
Merged

Reactive the viewcode extension for docs #11548

merged 1 commit into from
Jan 15, 2024

Conversation

Eric-Arellano
Copy link
Collaborator

We got source links working in API docs on docs.quantum.ibm.com! See Qiskit/documentation#620. To do this, we need to active sphinx.ext.viewcode.

Note that we still plan to improve this implementation in the future to have more precise links by using sphinx.ext.linkcode, tracked by Qiskit/documentation#517. This PR is to unblock the first iteration of this source links mechanism.

@Eric-Arellano Eric-Arellano added 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 Changelog: None Do not include in changelog labels Jan 11, 2024
@Eric-Arellano Eric-Arellano added this to the 0.45.2 milestone Jan 11, 2024
@Eric-Arellano Eric-Arellano requested a review from a team as a code owner January 11, 2024 18:48
@qiskit-bot
Copy link
Collaborator

One or more of the the following people are requested to review this:

@coveralls
Copy link

Pull Request Test Coverage Report for Build 7493193952

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage increased (+0.003%) to 89.288%
Totals Coverage Status
Change from base Build 7493140312: 0.003%
Covered Lines: 59508
Relevant Lines: 66647
💛 - Coveralls

@Eric-Arellano Eric-Arellano mentioned this pull request Jan 11, 2024
Closed
ElePT
ElePT approved these changes Jan 15, 2024
View reviewed changes
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.

This looks reasonable to my limited understanding, so approving to unblock the source links.

@ElePT ElePT added this pull request to the merge queue Jan 15, 2024
Merged via the queue into Qiskit:main with commit 3d794b6 Jan 15, 2024
13 checks passed
mergify bot pushed a commit that referenced this pull request Jan 15, 2024
@Eric-Arellano @mergify
Reactive the viewcode extension for docs (#11548)
b2d6fa5 
(cherry picked from commit 3d794b6)
@mergify mergify bot mentioned this pull request Jan 15, 2024
Merged
@Eric-Arellano Eric-Arellano deleted the restore-viewcode branch January 15, 2024 16:31
github-merge-queue bot pushed a commit that referenced this pull request Jan 15, 2024
@mergify @Eric-Arellano
Reactive the viewcode extension for docs (#11548) (#11569)
56fc27d 
(cherry picked from commit 3d794b6)

Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
ShellyGarion pushed a commit to ShellyGarion/qiskit-terra that referenced this pull request Jan 18, 2024
@Eric-Arellano @ShellyGarion
Reactive the viewcode extension for docs (Qiskit#11548)
8514d8b
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ElePT ElePT ElePT approved these changes

Assignees
No one assigned
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
Milestone
0.45.2
Development

Successfully merging this pull request may close these issues.
4 participants
@Eric-Arellano @qiskit-bot @coveralls @ElePT