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

Add favicon to kedro-viz documentation #1959

Merged
merged 4 commits into from
Jun 27, 2024
Merged

Add favicon to kedro-viz documentation #1959

merged 4 commits into from
Jun 27, 2024

Conversation

Huongg
Copy link
Contributor

@Huongg Huongg commented Jun 27, 2024

Description

Fixes #1724 , as a part of the ticket is to add the favicon to our documentation. Ideally we should do it directly in kedro-sphinx-theme.

However @astrojuanlu pointed out that there's some issue with Sphinx theme don't normally have their own conf.py (issue here), therefore the fix for now will be directly inside kedro-viz doc, and the same for kedro datasets

The favicon is now shown through the doc build https://kedro--1959.org.readthedocs.build/projects/kedro-viz/en/1959/

Checklist

  • Read the contributing guidelines
  • Opened this PR as a 'Draft Pull Request' if it is work-in-progress
  • Updated the documentation to reflect the code changes
  • Added new entries to the RELEASE.md file
  • Added tests to cover my changes

Signed-off-by: Huong Nguyen <huongg1409@gmail>
Signed-off-by: Huong Nguyen <huongg1409@gmail>
@Huongg Huongg requested a review from astrojuanlu as a code owner June 27, 2024 13:23
@Huongg Huongg requested review from jitu5 and SajidAlamQB June 27, 2024 13:24
@Huongg Huongg self-assigned this Jun 27, 2024
Huong Nguyen added 2 commits June 27, 2024 14:43
Signed-off-by: Huong Nguyen <huongg1409@gmail>
Signed-off-by: Huong Nguyen <huongg1409@gmail>
Copy link
Member

@astrojuanlu astrojuanlu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

]

favicons = [
"https://kedro.org/images/favicon.ico",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Huongg Is it possible to add favicon locally from repo instead of downloading from https://kedro.org/images/favicon.ico

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hey @jitu5 it's possible but it means we have to do the same download for framework and kedro-datasets, at the moment 3 repos are using the same image from the link

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel having it in one place for all the repos is easy for maintenance. Also, where are we actually downloading this favicon, here we are just defining the source. Do you know where is the download code ? or does sphinx do it internally

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we are already following this then its fine. I just asked because if the link somehow gets broken, it will break everywhere, and we won't know about it.

Copy link
Contributor Author

@Huongg Huongg Jun 27, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ravi-kumar-pilla it's just accessing the link, so the proper fix will be to get all of this handled inside kedro-sphinx-theme but it requires a lot of investigation i think. Juanlu has already opened the ticket for it so hopefully we get it fixed soon

Copy link
Contributor

@SajidAlamQB SajidAlamQB left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @Huongg!

Copy link
Contributor

@ravi-kumar-pilla ravi-kumar-pilla left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍 ... thank you @Huongg

@Huongg Huongg merged commit 1d14055 into main Jun 27, 2024
24 checks passed
@Huongg Huongg deleted the include-favicon branch June 27, 2024 14:44
@SajidAlamQB SajidAlamQB mentioned this pull request Jul 25, 2024
5 tasks
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

Successfully merging this pull request may close these issues.

Documentation: Catch up documentation with Framework
5 participants