Skip to content
This repository has been archived by the owner on Aug 19, 2023. It is now read-only.

"Installation" section of "Getting started" page is empty #1566

Closed
t-imamichi opened this issue Jul 14, 2022 · 2 comments · Fixed by #1567
Closed

"Installation" section of "Getting started" page is empty #1566

t-imamichi opened this issue Jul 14, 2022 · 2 comments · Fixed by #1567
Labels
bug Something isn't working documentation Something is not clear or error in description

Comments

@t-imamichi
Copy link
Member

t-imamichi commented Jul 14, 2022 •
edited
Loading

Informations

  • Qiskit version: NA
  • Python version: NA
  • Operating system: NA

What is the current behavior?

Getting started page has "Installation" section. But, it looks empty.
image

The source rst file contains some texts.
https://github.com/Qiskit/qiskit/blob/master/docs/getting_started.rst#installation

Steps to reproduce the problem

access: https://qiskit.org/documentation/getting_started.html

What is the expected behavior?

Show tabs in "Installation" section of https://qiskit.org/documentation/getting_started.html

Suggested solutions

No idea.
@t-imamichi t-imamichi added the bug Something isn't working label Jul 14, 2022
@HuangJunye HuangJunye added the documentation Something is not clear or error in description label Jul 14, 2022
@HuangJunye
Copy link
Contributor

Thanks for reporting the bug. I think this is caused by the PR #1558 that migrated sphinx-panel to sphinx-design extension and forgot to update the directive tabbed to the corresponding directive tab-set in sphinx-design.

Here is the migration guide: https://sphinx-design.readthedocs.io/en/latest/get_started.html#migrating-from-sphinx-panels

@t-imamichi
Copy link
Member Author

t-imamichi commented Jul 14, 2022 •
edited
Loading

I see. I checked the rst files and found that contributing_to_qiskit.rst also contains tabbed.
https://github.com/Qiskit/qiskit/blob/master/docs/contributing_to_qiskit.rst#set-up-the-virtual-development-environment

mtreinish added a commit to mtreinish/qiskit that referenced this issue Jul 14, 2022
@mtreinish
Update tab syntax for sphinx-design
97170be 
In Qiskit#1558 the sphinx plugin sphinx-panel was switched to sphinx-design to
enable building the documentation with sphinx >=5.0.0. However, while
the build succeeded there were warnings emitted about tabbed directive
which was only valid for sphinx-panel. This prevented any tabbed
sections in the documentation from being built as sphinx just ignored
it (this is why it's best practice to build with -W to make warnings
fatal because they're almost always pointing to broken docs). This
commit fixes this by migrating the directives to use the syntax from
sphinx-design so that we're building the tabs sections of the
documentation.

Fixes Qiskit#1566
@mtreinish mtreinish mentioned this issue Jul 14, 2022
Merged
@mergify mergify bot closed this as completed in #1567 Jul 14, 2022
mergify bot pushed a commit that referenced this issue Jul 14, 2022
@mtreinish
Update tab syntax for sphinx-design (#1567)
6d55b86 
In #1558 the sphinx plugin sphinx-panel was switched to sphinx-design to
enable building the documentation with sphinx >=5.0.0. However, while
the build succeeded there were warnings emitted about tabbed directive
which was only valid for sphinx-panel. This prevented any tabbed
sections in the documentation from being built as sphinx just ignored
it (this is why it's best practice to build with -W to make warnings
fatal because they're almost always pointing to broken docs). This
commit fixes this by migrating the directives to use the syntax from
sphinx-design so that we're building the tabs sections of the
documentation.

Fixes #1566
jakelishman pushed a commit to jakelishman/qiskit-terra that referenced this issue Aug 11, 2023
@mtreinish
Update tab syntax for sphinx-design (Qiskit/qiskit-metapackage#1567)
625a5ec 
In Qiskit/qiskit-metapackage#1558 the sphinx plugin sphinx-panel was switched to sphinx-design to
enable building the documentation with sphinx >=5.0.0. However, while
the build succeeded there were warnings emitted about tabbed directive
which was only valid for sphinx-panel. This prevented any tabbed
sections in the documentation from being built as sphinx just ignored
it (this is why it's best practice to build with -W to make warnings
fatal because they're almost always pointing to broken docs). This
commit fixes this by migrating the directives to use the syntax from
sphinx-design so that we're building the tabs sections of the
documentation.

Fixes Qiskit/qiskit-metapackage#1566
SamD-1998 pushed a commit to SamD-1998/qiskit-terra that referenced this issue Sep 7, 2023
@mtreinish @SamD-1998
Update tab syntax for sphinx-design (Qiskit/qiskit-metapackage#1567)
53f4247 
In Qiskit/qiskit-metapackage#1558 the sphinx plugin sphinx-panel was switched to sphinx-design to
enable building the documentation with sphinx >=5.0.0. However, while
the build succeeded there were warnings emitted about tabbed directive
which was only valid for sphinx-panel. This prevented any tabbed
sections in the documentation from being built as sphinx just ignored
it (this is why it's best practice to build with -W to make warnings
fatal because they're almost always pointing to broken docs). This
commit fixes this by migrating the directives to use the syntax from
sphinx-design so that we're building the tabs sections of the
documentation.

Fixes Qiskit/qiskit-metapackage#1566
Eric-Arellano pushed a commit to Qiskit/documentation that referenced this issue Oct 12, 2023
@mtreinish
Update tab syntax for sphinx-design (Qiskit/qiskit-metapackage#1567)
50304d4 
In Qiskit/qiskit-metapackage#1558 the sphinx plugin sphinx-panel was switched to sphinx-design to
enable building the documentation with sphinx >=5.0.0. However, while
the build succeeded there were warnings emitted about tabbed directive
which was only valid for sphinx-panel. This prevented any tabbed
sections in the documentation from being built as sphinx just ignored
it (this is why it's best practice to build with -W to make warnings
fatal because they're almost always pointing to broken docs). This
commit fixes this by migrating the directives to use the syntax from
sphinx-design so that we're building the tabs sections of the
documentation.

Fixes Qiskit/qiskit-metapackage#1566
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
bug Something isn't working documentation Something is not clear or error in description
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Update tab syntax for sphinx-design mtreinish/qiskit
2 participants
@HuangJunye @t-imamichi