qBraid / qBraid-Lab

Web-based JupyterLab deployment providing curated software tools for for researchers and developers in quantum computing.
https://lab.qbraid.com
Apache License 2.0
2 stars 1 forks source link

Create top-bar matching qBraid homepage #5

Closed ryanhill1 closed 9 months ago

ryanhill1 commented 1 year ago

We want to update our readthedocs page so that it uses a header that matches our homepage to make it seem more like all of one website. Our current readthedocs page looks as follows:

Screenshot 2023-10-09 at 2 30 17 PM

And our homepage looks like this:

https://www.qbraid.com/

Screenshot 2023-10-09 at 2 30 50 PM

So we want to merge the style of the header into this docs page to make them more like one website

https://docs.qbraid.com/

Screenshot 2023-10-09 at 2 47 43 PM

Example

As an example, take a look at Pennylane's website, who do pretty much exactly what we're looking for. The transition from their website to their docs page is so seemless that the user hardly notices that they've been redirected to a new site.

https://pennylane.ai/

Screenshot 2023-10-09 at 2 48 18 PM

https://docs.pennylane.ai/

Screenshot 2023-10-09 at 2 48 43 PM

Because of the way our qBraid homepage header looks, we wont be able to match as identically as Pennylane does. But in this issue we just want to establish the same header style to start on the way to some uniformity.

ryanhill1 commented 1 year ago

Update: Add header templates into new https://github.com/qBraid/qbraid-sphinx-theme

ryanhill1 commented 1 year ago

Update: After browsing around on https://sphinx-themes.org/ I found https://sphinx-themes.org/sample-sites/piccolo-theme/ (https://github.com/piccolo-orm/piccolo_theme/) which seems to match our specifications much more closely and I think can be customized to create the header and match our existing qBraid theme/style, like you were initially doing with the xanadu theme before.

After seeing all of the other built-in themes that exist, I'm more inclined now to maybe build off of this one rather than create our own. Initially, the xanadu theme just seemed like it was so different than what we were going for that it would have required so many modifications that we might as well build our own. But this "piccolo" theme linked above already seems pretty close to what we are going for. https://sphinx-themes.org/sample-sites/sphinx-press-theme/ is another good candidate if that one doesn't work out.

If neither of the above linked themes provide enough customization options, then we can always default back to trying to build off of the https://github.com/readthedocs/sphinx_rtd_theme, or again, building our own.