Fix Furo styling for API pages with methods on class page #458
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Eric-Arellano
force-pushed
the
EA/change-autodoc
branch
from
3b02b30 to
1b10dd3
Compare
Eric-Arellano
changed the title
|
oof yeah these pages are a lot busier now with all these method docs strings. We definitely need to rethink from a design perspective how to make these pages generally feel less overwhelming (I think @frankharkins was planning on doing some work on this?). In the meantime, how do we feel about using 2px purple lines for h2 level titles and 1px purple lines for h3? |
javabster
approved these changes
Jul 11, 2023
| @@ -76,7 +94,7 @@ dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(. | |||
| // section headers like "Attributes" and "Methods". We disagree with the design in | |||
| // https://github.com/pradyunsg/furo/discussions/505. Instead, use the rules from `p.rubric`. | |||
| dl.py dd p.rubric { | |||
| font-size: 1.125em; | |||
| font-size: 125%; // We make this bigger than p.rubric to match the bigger font sizes for the page. | |||
There was a problem hiding this comment.
I have a feeling that using percentage for font size is not best practice and it's better to use rem, but not confident. I think it depends if we want the size to be relative to the parent element or relative to the root element
There was a problem hiding this comment.
I went with percentage because I realized it's what Furo itself is using. So be consistent.
Eric-Arellano
added a commit
to Eric-Arellano/qiskit_sphinx_theme
that referenced
this pull request
Jul 11, 2023
We're planning to switch some Qiskit projects to stop having dedicated HTML pages per method, mostly due to performance concerns. Closes Qiskit#466. Methods were using `inline-block` rather than `block` when on the classes page, which resulted in a bug when highlighting over the method to show the `#` anchor tag:  Instead, we now turn off floating of the `[source]` label because it causes issues on long code signatures:  After:  Even though the `[source]` floating to the right is more "elegant", we have too many long signatures in Qiskit to be worth it. It's safer to turn off the float. This also improves the information hierarchy so that page feels less crowded. Relates to Qiskit#459: * Use a border-width of 2px for top-level code objects, but otherwise 1 * Increases the font sizes so headings look bigger.
Eric-Arellano
added a commit
that referenced
this pull request
Jul 11, 2023
…k of #458) (#478) We're planning to switch some Qiskit projects to stop having dedicated HTML pages per method, mostly due to performance concerns. Closes #466. Methods were using `inline-block` rather than `block` when on the classes page, which resulted in a bug when highlighting over the method to show the `#` anchor tag:  Instead, we now turn off floating of the `[source]` label because it causes issues on long code signatures:  After:  Even though the `[source]` floating to the right is more "elegant", we have too many long signatures in Qiskit to be worth it. It's safer to turn off the float. This also improves the information hierarchy so that page feels less crowded. Relates to #459: * Use a border-width of 2px for top-level code objects, but otherwise 1 * Increases the font sizes so headings look bigger.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Background
We're planning to switch some Qiskit projects to stop having dedicated HTML pages per method, mostly due to performance concerns.
Styling changes
Closes #466. Methods were using
inline-blockrather thanblockwhen on the classes page, which resulted in a bug when highlighting over the method to show the#anchor tag:Instead, we now turn off floating of the
[source]label because it causes issues on long code signatures:After:
Even though the
[source]floating to the right is more "elegant", we have too many long signatures in Qiskit to be worth it. It's safer to turn off the float.This also improves the information hierarchy so that page feels less crowded. Relates to #459: