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

Github links #568

Open
IceKhan13 opened this issue Oct 3, 2023 · 1 comment
Open

Github links #568

IceKhan13 opened this issue Oct 3, 2023 · 1 comment

Comments

@IceKhan13
Copy link
Member

IceKhan13 commented Oct 3, 2023

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
Copy link
Collaborator

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.

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

2 participants