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

Link to qiskit.synthesis.unitary.aqc on API index page (backport #12331) #12344

Closed
wants to merge 1 commit into from

Conversation

mergify[bot]
Copy link
Contributor

@mergify mergify bot commented May 5, 2024

Before, qiskit.synthesis.unitary.aqc was autogenerated by autosummary rather than being manually created like we normally do in apidoc/. This had two issues:

  1. The module does not show up in the API index page https://docs.quantum.ibm.com/api/qiskit, even though it shows up as top-level in the doc app's left table of contents
  2. The header hierarchy is messed up due to an autosummary quirk that I could not figure out how to fix Fix unnecessary h1 header in module pages generated by autosummary documentation#1272

Using a dedicated page fixes both of these problems.

I named the file qiskit.synthesis.unitary.aqc to preserve the previous URL we had for the module, so that we don't need redirects. (Technically, Sphinx now puts the HTML file in the apidoc/ folder rather than stubs/, but the docs app doesn't care.)

All the other modules were fine.


This is an automatic backport of pull request #12331 done by Mergify.

* Link to `qiskit.synthesis.unitary.aqc` on API index page

* Add to index page

(cherry picked from commit 27bd5e7)
@mergify mergify bot requested review from alexanderivrii, ShellyGarion and a team as code owners May 5, 2024 16:04
@qiskit-bot
Copy link
Collaborator

Thank you for opening a new pull request.

Before your PR can be merged it will first need to pass continuous integration tests and be reviewed. Sometimes the review process can be slow, so please be patient.

While you're waiting, please feel free to review other open PRs. While only a subset of people are authorized to approve pull requests for merging, everyone is encouraged to review open pull requests. Doing reviews helps reduce the burden on the core team and helps make the project's code better for everyone.

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

@github-actions github-actions bot added documentation Something is not clear or an error documentation Changelog: None Do not include in changelog labels May 5, 2024
@github-actions github-actions bot added this to the 1.1.0 milestone May 5, 2024
@Eric-Arellano Eric-Arellano requested a review from ElePT May 6, 2024 15:06
@Eric-Arellano
Copy link
Collaborator

This was meant to target stable/1.1. Superseded by #12352

@Eric-Arellano Eric-Arellano deleted the mergify/bp/stable/1.0/pr-12331 branch May 6, 2024 19:23
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants