search

Qiskit / qiskit_sphinx_theme

A Sphinx theme and documentation guidelines for Qiskit and Qiskit Ecosystem projects
https://qisk.it/docs-guide
Apache License 2.0
15 stars 29 forks source link

Ecosystem: Add project name to mobile header #494

Closed Eric-Arellano closed 1 year ago

Eric-Arellano commented 1 year ago

Closes https://github.com/Qiskit/qiskit_sphinx_theme/issues/484.

For the Ecosystem, we revert back to Furo's default mobile header design, which includes the project name. That works well because we don't have the top Qiskit nav bar.

Our only change is to use a Carbon icon for the hamburger icon.

Vendors page.html

Rather than inherting page.html from our base Qiskit theme, we re-vendor page.html from Furo directly for the ecosystem. That is because the Qiskit theme makes several changes that we don't like, like adding the top Qiskit nav bar.

Our only divergence from Furo with the Ecosystem is to add analytics in the footer.

Removes docs text from Search

This change impacts both the Qiskit and Ecosystem themes. For most projects, it is redundant to say "docs": the only site for the entire project is the docs site! So search is for the entire project.

The only exception is Terra, since search only applies to the docs subsite and not qiskit.org. But we can workaround that by changing the project name in Terra's conf.py to say Qiskit documentation.

coruscating commented 1 year ago

We're planning on using the git describe version for the development site, which pushes "documentation" to the next row:

image

I'd rather not have "documentation" at all. If we're keeping it, I think it looks better capitalized.

Eric-Arellano commented 1 year ago

@coruscating, see https://github.com/pradyunsg/furo/discussions/202#discussioncomment-1045053. Tl;dr: set html_title in conf.py.

I do not think we should diverge from Furo's source code here. But, we should document this in https://github.com/Qiskit/qiskit_sphinx_theme/issues/486.

Update: this PR now sets html_title.

Eric-Arellano commented 1 year ago

I think writing out html_title in the example conf.py helps a lot with adoption and customization.

Agreed! I'll mention it in the README also in a follow up.