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
14 stars 29 forks source link

Github links #568

Open IceKhan13 opened 10 months ago

IceKhan13 commented 10 months ago

As a user I want a clear way to navigate from documentation of project to repository. Like github button or anchor or sticker.

Sphinx alabaster theme is doing something like this

Screenshot 2023-10-03 at 3 50 55 PM

when configuration is set

html_theme_options = {
    "github_user": "qiskit-community",
    "github_repo": "amazing_repo",
    "github_button": True,
}
kevinsung commented 2 months ago

FYI you can see here for what Furo itself does. It gives a GitHub icon on the bottom right, perhaps not as visible as you want.