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

[Docs] show favicon in documentation #1150

Closed
lisphilar opened this issue Sep 3, 2022 · 5 comments · Fixed by #1151
Closed

[Docs] show favicon in documentation #1150

lisphilar opened this issue Sep 3, 2022 · 5 comments · Fixed by #1151
Labels
documentation Improvements or additions to documentation

Comments

@lisphilar
Copy link
Owner

What we need to document?

Show favicon in documentation.

@lisphilar lisphilar added the documentation Improvements or additions to documentation label Sep 3, 2022
@lisphilar lisphilar added this to the Release v2.26.0 milestone Sep 3, 2022
@lisphilar
Copy link
Owner Author

@lisphilar
Copy link
Owner Author

lisphilar commented Sep 3, 2022

  1. added sphinx-favicon as a dev dependency
  2. add lines to docs/conf.py
# -- General configuration ---------------------------------------------------
extensions = [
    'sphinx-favicon',
]
# -- Extension configuration -------------------------------------------------
favicons = {
    "rel": "icon",
    "sizes": "32x32",
    "href": "https://github.com/lisphilar/covid19-sir/blob/master/docs/logo/covsirphy_favicon.png",
}

Updated with 47ba70d

@lisphilar
Copy link
Owner Author

lisphilar commented Sep 3, 2022

The favicon file (PNG) was saved in this repository and called with the absolute URL.

@lisphilar lisphilar reopened this Sep 3, 2022
lisphilar added a commit that referenced this issue Sep 3, 2022
lisphilar added a commit that referenced this issue Sep 3, 2022
lisphilar added a commit that referenced this issue Sep 3, 2022
lisphilar added a commit that referenced this issue Sep 3, 2022
lisphilar added a commit that referenced this issue Sep 3, 2022
lisphilar added a commit that referenced this issue Sep 3, 2022
@lisphilar
Copy link
Owner Author

Finally successed with the followings.

html_favicon = "https://raw.githubusercontent.com/lisphilar/covid19-sir/master/docs/logo/covsirphy_favicon.ico"

@lisphilar
Copy link
Owner Author

.ico file was required and I created it with free software.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant