PyTomography icon indicating copy to clipboard operation
PyTomography copied to clipboard

Add link to github repository in the docs

Open ShaiAvr opened this issue 2 years ago • 0 comments

I find it slightly annoying that there is no direct link in the documentation to the GitHub repository. Since you are using the pydata theme, it is extremely easy to add links to GitHub and any other external resources which are easily available on the top of the site. Look at the docs of pydata itself for example:

Screenshot 2023-11-05 102950

Adding such a link to GitHub is as simple as adding:

html_theme_options = {
    "icon_links": [
        {
            "name": "GitHub",
            "url": "https://github.com/qurit/PyTomography",
            "icon": "fa-brands fa-github",
            "type": "fontawesome",
        },
    ],
}

to conf.py. If there are no objections or issues, I can make a PR to implement this change.

ShaiAvr avatar Nov 05 '23 09:11 ShaiAvr