Skip to content
This repository has been archived by the owner on Jul 24, 2024. It is now read-only.

Methods live on class pages #789

Merged
merged 2 commits into from
Jan 12, 2024

Conversation

Eric-Arellano
Copy link
Collaborator

Currently, methods live on dedicated HTML pages rather than their class pages.

But in qiskit/documentation, we merge those methods to live on the class page because it's a better user experience. While we do have code to do that, it's simpler to change Provider's config to have Sphinx do the right thing from the start.

This template is copied from qiskit-ibm-runtime.

@Eric-Arellano Eric-Arellano added the documentation Improvements or additions to documentation label Jan 12, 2024
@Eric-Arellano Eric-Arellano requested a review from kt474 January 12, 2024 17:02
@coveralls
Copy link

Pull Request Test Coverage Report for Build 7506157926

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 51.505%

Totals Coverage Status
Change from base Build 7425166642: 0.0%
Covered Lines: 3440
Relevant Lines: 6679

💛 - Coveralls

@Eric-Arellano Eric-Arellano merged commit db8ebe1 into Qiskit:main Jan 12, 2024
19 checks passed
@Eric-Arellano Eric-Arellano deleted the methods-class-page branch January 12, 2024 19:49
Eric-Arellano added a commit to Eric-Arellano/qiskit-ibm-provider that referenced this pull request Jan 12, 2024
Currently, methods live on dedicated HTML pages rather than their class pages. 

But in qiskit/documentation, we merge those methods to live on the class page because it's a better user experience. While we do have code to do that, it's simpler to change Provider's config to have Sphinx do the right thing from the start.

This template is copied from qiskit-ibm-runtime.
Eric-Arellano added a commit to Eric-Arellano/qiskit-ibm-provider that referenced this pull request Jan 12, 2024
Currently, methods live on dedicated HTML pages rather than their class pages. 

But in qiskit/documentation, we merge those methods to live on the class page because it's a better user experience. While we do have code to do that, it's simpler to change Provider's config to have Sphinx do the right thing from the start.

This template is copied from qiskit-ibm-runtime.
kt474 pushed a commit that referenced this pull request Jan 12, 2024
Currently, methods live on dedicated HTML pages rather than their class pages. 

But in qiskit/documentation, we merge those methods to live on the class page because it's a better user experience. While we do have code to do that, it's simpler to change Provider's config to have Sphinx do the right thing from the start.

This template is copied from qiskit-ibm-runtime.
kt474 pushed a commit that referenced this pull request Jan 12, 2024
Currently, methods live on dedicated HTML pages rather than their class pages. 

But in qiskit/documentation, we merge those methods to live on the class page because it's a better user experience. While we do have code to do that, it's simpler to change Provider's config to have Sphinx do the right thing from the start.

This template is copied from qiskit-ibm-runtime.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants