This repository has been archived by the owner on Aug 21, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Remove index page #1315
Labels
Comments
SaumyaBhushan
pushed a commit
to SaumyaBhushan/qiskit-tutorials
that referenced
this issue
May 19, 2022
The index pages are required for building the tutorials in standalone docs builds. Without the index files for each section the tutorials will not be included in the toctree for the build. This will cause warnings which will be fatal in downstream builds (such as in qiskit component CI) and a docs build output where you can't navigate to the tutorials (assuming it builds them). |
I suspected that. Is it possible to exclude index.rst in the glob rules under each section in qiskit meta package repo? |
This PR #1234 tried to address this issue but it was put on hold. Let me investigate a bit further. |
This was referenced Jul 11, 2023
mergify bot
pushed a commit
that referenced
this issue
Jul 11, 2023
Closes #1315. As explained there, these `index.rst` pages result in our Tutorials home page having extra entries that simply link to that section's other entries. This PR fixes it by mirroring `tutorials.rst` from `qiskit-metapackage`. Our `index.html` now directly calls `nbgallery` with `glob`, rather than referring to `index.rst` using normal Sphinx mechanisms. That results in this tutorials repo rendering like this: ![Screenshot 2023-07-11 at 9 54 04 AM](https://github.com/Qiskit/qiskit-tutorials/assets/14852634/b12c151e-d2c2-4f5b-ad50-18703708046d) The metapackage ignores this repo's `index.rst` and only copies over the `tutorials/` folder. So, it will copy over the same content as before, only now without the `index.rst` files in each subfolder. --------- Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Co-authored-by: Eric Arellano <ericarellano@me.com>
robotAstray
pushed a commit
to robotAstray/qiskit-algorithms
that referenced
this issue
Aug 7, 2023
Closes Qiskit/qiskit-tutorials#1315. As explained there, these `index.rst` pages result in our Tutorials home page having extra entries that simply link to that section's other entries. This PR fixes it by mirroring `tutorials.rst` from `qiskit-metapackage`. Our `index.html` now directly calls `nbgallery` with `glob`, rather than referring to `index.rst` using normal Sphinx mechanisms. That results in this tutorials repo rendering like this: ![Screenshot 2023-07-11 at 9 54 04 AM](https://github.com/Qiskit/qiskit-tutorials/assets/14852634/b12c151e-d2c2-4f5b-ad50-18703708046d) The metapackage ignores this repo's `index.rst` and only copies over the `tutorials/` folder. So, it will copy over the same content as before, only now without the `index.rst` files in each subfolder. --------- Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Co-authored-by: Eric Arellano <ericarellano@me.com>
ElePT
pushed a commit
to ElePT/qiskit-algorithms
that referenced
this issue
Aug 17, 2023
…it/qiskit-tutorials#1322) Closes Qiskit/qiskit-tutorials#1315. As explained there, these `index.rst` pages result in our Tutorials home page having extra entries that simply link to that section's other entries. This PR fixes it by mirroring `tutorials.rst` from `qiskit-metapackage`. Our `index.html` now directly calls `nbgallery` with `glob`, rather than referring to `index.rst` using normal Sphinx mechanisms. That results in this tutorials repo rendering like this: ![Screenshot 2023-07-11 at 9 54 04 AM](https://github.com/Qiskit/qiskit-tutorials/assets/14852634/b12c151e-d2c2-4f5b-ad50-18703708046d) The metapackage ignores this repo's `index.rst` and only copies over the `tutorials/` folder. So, it will copy over the same content as before, only now without the `index.rst` files in each subfolder. --------- Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Co-authored-by: Eric Arellano <ericarellano@me.com>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Informations
What is the current behavior?
Each section in the tutorial page has its own index page showing up as an icon similar to the tutorials itself which is confusing.
Steps to reproduce the problem
Go to https://qiskit.org/documentation/tutorials.html#quantum-circuits, click the last icon "circuit tutorials".
It will lead to this page https://qiskit.org/documentation/tutorials/circuits/index.html which contain the same tutorials in the section but in its own page.
What is the expected behavior?
Remove index page of each section in https://qiskit.org/documentation/tutorials.html
Suggested solutions
Either remove index.rst in each folders of qiskit-tutorials repo or update the glob rule in tutorials.rst in qiskit meta package
The text was updated successfully, but these errors were encountered: