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

[ DESIGN ] Update API Docs Styling #521

Closed
Tracked by #479
Eric-Arellano opened this issue Dec 13, 2023 · 2 comments
Closed
Tracked by #479

[ DESIGN ] Update API Docs Styling #521

Eric-Arellano opened this issue Dec 13, 2023 · 2 comments
Assignees
Labels
design 🎨 infra 🏗️ UI feedback rendering/layout issues with the user interface

Comments

@Eric-Arellano
Copy link
Collaborator

Part of #479. This issue is focused on the visual design of the API docs.

Right now, API docs are not using design elements to accurately reflect information hierarchy. For example, no colors or indentation.

This is an example class:

Screenshot 2023-12-13 at 1 37 26 PM

Some methods:

Screenshot 2023-12-13 at 1 38 13 PM

A standalone function, but note that it starts after the Return type QasmQobj | PulseQobj text:

Screenshot 2023-12-13 at 1 39 09 PM

Compare to qiskit.org

These screenshots come from our repository for the Qiskit Sphinx Theme, the files starting with api-docs-: https://github.com/Qiskit/qiskit_sphinx_theme/tree/main/tests/js/tests.js-snapshots

A class with methods:

image

A module page showing a standalone function
image

@Eric-Arellano Eric-Arellano added infra 🏗️ UI feedback rendering/layout issues with the user interface labels Dec 13, 2023
@Eric-Arellano Eric-Arellano added this to the 24-02-13 Qiskit 1.0 milestone Dec 13, 2023
@Eric-Arellano Eric-Arellano changed the title Redesign API docs Update API Docs Styling Dec 13, 2023
@javabster javabster moved this to In Progress in Docs Planning Jan 22, 2024
@Eric-Arellano Eric-Arellano removed this from the 24-02-13 Qiskit 1.0 milestone Jan 26, 2024
@Eric-Arellano Eric-Arellano moved this from In Progress to In Review in Docs Planning Jan 29, 2024
@javabster javabster changed the title Update API Docs Styling [ DESIGN ] Update API Docs Styling Jan 29, 2024
@gracelindsell
Copy link
Collaborator

@Eric-Arellano Here are the breakpoints for the API Docs styling. To the right please find a version without indentation for initial implementation

@Eric-Arellano
Copy link
Collaborator Author

Thanks! Implementation is tracked by #735 and #736, where I also put screenshots.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
design 🎨 infra 🏗️ UI feedback rendering/layout issues with the user interface
Projects
Archived in project
Development

No branches or pull requests

4 participants