Add qiskit-card-item and qiskit-call-to-action-item directives
#326
Conversation
| .. raw:: html | ||
|
|
||
| <div class="tutorials-callout-container"> | ||
| <div class="row"> |
There was a problem hiding this comment.
FYI this is not included in the customcalloutitem because it's common to have multiple "items" in a group. This is the outer container code.
| customcarditem | ||
| ============== | ||
|
|
||
| .. raw:: html |
There was a problem hiding this comment.
Ditto that this is not included in the customcarditem because it's common to have multiple "items" in a group. This is the outer container code.
| @@ -29,6 +29,7 @@ | |||
| "Framework :: Sphinx :: Theme", | |||
| ], | |||
| install_requires=[ | |||
| "docutils", | |||
There was a problem hiding this comment.
FYI this was already being installed via Sphinx. But it's a best practice to explicitly list out all dependencies that we directly depend on, i.e. that we import.
Eric-Arellano
changed the title
customcardelement and customcalloutitem directivesqiskit-card-item and qiskit-call-to-action-item directives
Eric-Arellano
force-pushed
the
dry-directives
branch
from
4108dfe
to
a93fbb6
Compare
There was a problem hiding this comment.
I'm generally okay with this, but is it doing something that can't be done with sphinx-design and custom CSS?
I have a feeling this is the direction we'll want to go. But we were thinking it's not really a high priority to make that migration in the next month, compared to things like Furo. So for now, at least make things less bad by removing the duplication across 6 projects. |
| @@ -1,6 +1,6 @@ | |||
| # This code is part of Qiskit. | |||
| # | |||
| # (C) Copyright IBM 2018, 2023. | |||
| # (C) Copyright IBM 2021, 2023. | |||
There was a problem hiding this comment.
what is this change for?
There was a problem hiding this comment.
Looking at Git history, the file was first introduced 2021, not 2018. So I fixed it to not lie.
Co-authored-by: Abby Mitchell <[email protected]>
Closes #323. These are used by several Qiskit projects, so we should de-duplicate them.
Alternative considered: stop using these elements
For example, these elements will be somewhat tricky to get working with Furo: #327.
We considered removing these design elements and instead using standard Sphinx. For example, rather than having
qiskit-call-to-action-itemwith its clickable button to go to a URL, we could instead rely on normal Sphinx links, or the left table of contents, and decide we don't care about the button.We decided that we like these design elements enough to keep them. It would be a UX regression to remove them. We may want to improve the styling—but we will still need the RST directive. We may also remove these directives in some future, but only after finding a better alternative.