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 manual Table of Contents in favor of autogenerated Page Table of Contents #1180

Merged
merged 1 commit into from
May 25, 2023

Conversation

Eric-Arellano
Copy link
Contributor

This is a better fix for the problem described in #1179.

@woodsp-ibm and I realized that it's redundant for us to have a manual Table of Contents section in the docs. qiskit_sphinx_theme will already auto-generate a page table of contents. It's duplicative to have our own manual section too.

image

We suspect that we picked up this habit from old docs that did it before qiskit_sphinx_theme used Pytorch to autogenerate the page table of contents. It's now an out-of-date practice that has a bad user experience & results in the issue in #1179.

@coveralls
Copy link

Pull Request Test Coverage Report for Build 5082182349

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 1 unchanged line in 1 file lost coverage.
  • Overall coverage decreased (-0.009%) to 87.471%

Files with Coverage Reduction New Missed Lines %
qiskit_nature/second_q/drivers/psi4d/psi4driver.py 1 84.75%
Totals Coverage Status
Change from base Build 5054742046: -0.009%
Covered Lines: 9404
Relevant Lines: 10751

💛 - Coveralls

Copy link
Member

@mrossinek mrossinek left a comment

Choose a reason for hiding this comment

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

Thanks for fixing this!

@mrossinek mrossinek merged commit 28c8952 into qiskit-community:main May 25, 2023
mergify bot pushed a commit that referenced this pull request May 25, 2023
…of Contents (#1180)

(cherry picked from commit 28c8952)

# Conflicts:
#	docs/migration/0.5_b_solving_problems.rst
#	docs/migration/0.5_c_electronic_structure.rst
#	docs/migration/0.5_d_vibrational_structure.rst
#	docs/migration/0.5_e_lattice_models.rst
@woodsp-ibm woodsp-ibm removed the stable backport potential The bug might be minimal and/or import enough to be port to stable label May 25, 2023
@woodsp-ibm
Copy link
Member

Was not quick enough to remove the backport label. We still have notebooks there right

@Eric-Arellano Eric-Arellano deleted the rm-table-of-contents branch May 25, 2023 17:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation Issues related to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants