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

Allow manually created class pages #1382

Merged
merged 1 commit into from
May 15, 2024
Merged

Allow manually created class pages #1382

merged 1 commit into from
May 15, 2024

Conversation

Eric-Arellano
Copy link
Collaborator

This unblocks Qiskit/qiskit#12403. Without this PR, we incorrectly treat the class as inline, which means it gets the blue left bar and an h3 incorrectly added.

Without this PR, our test to check that the ToC and index page are in sync also fails, even though things behave how we expect (Qiskit/qiskit#12403 (review))

@Eric-Arellano
Copy link
Collaborator Author

fyi @jakelishman - this makes the preview better than what you had been seeing. #1380 is updated already to use this.

@jakelishman
Copy link
Member

oh cool, thanks! Fwiw, I quite liked the blue bar on the standalone class pages anyway - it gave everything a nice consistency - but I also don't mind if it's not there.

@Eric-Arellano
Copy link
Collaborator Author

I quite liked the blue bar on the standalone class pages anyway - it gave everything a nice consistency - but I also don't mind if it's not there.

Design didn't want it for standalone pages because it adds too much noise to the page and increases indentation unnecessarily. We also don't use the purple bar for standalone function pages like https://docs.quantum.ibm.com/api/qiskit/qiskit.visualization.array_to_latex

@jakelishman
Copy link
Member

I'd kind of interpreted the purple bar as meaning "method" rather than "function", so it didn't feel inconsistent to me when that was missing. The blue bar tying together a class didn't feel noisy or too indenting to me - it felt quite nice tying together an entire "object", regardless of where it was.

But anyway, that's not important at all. If it wasn't meant to have one, it's better that it doesn't accidentally get one because of mistaken parsing.

Copy link
Collaborator

@arnaucasau arnaucasau left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Both the code and the preview look good, thanks!

@Eric-Arellano Eric-Arellano added this pull request to the merge queue May 15, 2024
Merged via the queue into main with commit 7c57676 May 15, 2024
2 checks passed
@Eric-Arellano Eric-Arellano deleted the EA/prep-12403 branch May 15, 2024 11:49
frankharkins pushed a commit to frankharkins/documentation that referenced this pull request Jul 22, 2024
This unblocks Qiskit/qiskit#12403. Without this
PR, we incorrectly treat the class as inline, which means it gets the
blue left bar and an h3 incorrectly added.

Without this PR, our test to check that the ToC and index page are in
sync also fails, even though things behave how we expect
(Qiskit/qiskit#12403 (review))
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants