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

Furo: audit that it includes all relevant common files we export with theme #316

Closed
Eric-Arellano opened this issue May 11, 2023 · 1 comment
Milestone

Comments

@Eric-Arellano
Copy link
Collaborator

Relates to #262.

We have several files that downstream repos may expect to have. For example, they may depend on some of these images:

├── images
│   ├── chevron-down-grey.svg
│   ├── chevron-right-purple.svg
│   ├── chevron-right-white.svg
│   ├── icon-close.svg
│   ├── icon-menu-dots-dark.svg
│   ├── launch.svg
│   ├── logo-facebook-dark.svg
│   ├── logo-icon.svg
│   ├── logo-twitter-dark.svg
│   ├── logo-youtube-dark.svg
│   ├── logo.png
│   ├── logo.svg
│   ├── logo_wordmark.svg
│   ├── qiskit-chevron-down.svg
│   ├── qiskit-chevron-up.svg
│   ├── search-icon.svg
│   └── view-page-source-icon.svg

To check for usage, we should grep for the file name. If it's not used by any HTML templates and also not used by their conf.py, e.g. for the below setting, we should be fine:

nbsphinx_thumbnails = {
    "sphinx_guide/notebook": "_static/images/logo.png",
}
@Eric-Arellano Eric-Arellano added this to the Furo milestone May 11, 2023
@Eric-Arellano
Copy link
Collaborator Author

Confirmed we're good to go. logo.png is the only one used according to ripgrepping every file against every Qiskit project.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant