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

Left-side TOC collapsed into right-side TOC #62

Closed
mhostetter opened this issue Apr 17, 2022 · 4 comments · Fixed by #63
Closed

Left-side TOC collapsed into right-side TOC #62

mhostetter opened this issue Apr 17, 2022 · 4 comments · Fixed by #63

Comments

@mhostetter
Copy link
Contributor

I discovered that the changes in 1373cd7 cause issues with the left-side and right-side TOCs. Here is my repo built with two consecutive commits. The individual pages in a navigation tab TOC are combined into subheading of one page.

Also, FWIW, the page title on the left-side TOC is colored differently...

Here is a chunk of index.rst.

.. toctree::
   :caption: Getting Started
   :hidden:

   getting-started.rst

.. toctree::
   :caption: Basic Usage
   :hidden:

   basic-usage/galois-field-classes.rst
   basic-usage/compilation-modes.rst
   basic-usage/field-element-representation.rst
   basic-usage/array-creation.rst
   basic-usage/array-arithmetic.rst
   basic-usage/linear-algebra.rst
   basic-usage/poly-creation.rst
   basic-usage/poly-arithmetic.rst

.. toctree::
   :caption: Tutorials
   :hidden:

   tutorials/intro-to-prime-fields.rst
   tutorials/intro-to-extension-fields.rst

Built with e928b18

image

Built with 1373cd7

image

@mhostetter
Copy link
Contributor Author

I just discovered that the TOCs only render incorrectly on the first page in the toctree, "Galois Field Classes" in my case.

You can reproduce this on https://galois.readthedocs.io/en/latest/basic-usage/galois-field-classes.html with these steps:

  • Click the "Basic Usage" navigation tab. Notice there is no left-side TOC.

image

  • Click "Compilation Modes" on the right-side TOC. Notice the left-side and right-side TOCs are back in place.

image

  • Click "Galois Field Classes" on the left side and notice the TOCs are messed up again.

@jbms
Copy link
Owner

jbms commented Apr 17, 2022

I will have to look into this. The first page toc is handled specially so it makes sense that there could be a problem only affecting that.

jbms added a commit that referenced this issue Apr 17, 2022
Fixes #62.

Thanks to @mhostetter for reporting.
@jbms
Copy link
Owner

jbms commented Apr 17, 2022

Note: This issue can also be reproduced with this own theme's documentation:

Notice the incorrect collapsing of the left TOC on this page:

https://jbms.github.io/sphinx-immaterial/demo_api.html

vs this page

https://jbms.github.io/sphinx-immaterial/specimen.html

@jbms jbms closed this as completed in #63 Apr 17, 2022
@mhostetter
Copy link
Contributor Author

Thank you @jbms! I can confirm the merged fix resolved my issues.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants