Skip to content

Doc: add a link to call the 'ewoks' main project. #82

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.

Sign up for GitHub

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

Merged
payno merged 7 commits into from
Jun 10, 2026
Merged

Doc: add a link to call the 'ewoks' main project. #82

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
8010525
Doc: add a link to call the 'ewoks' main project.
payno Jun 5, 2026
4391e9c
doc - tutorials: increase logo size to match the existing one
payno Jun 5, 2026
66e34c5
doc: move the ewoks documentation to the 'html_theme_options' icon
payno Jun 9, 2026
eb1463a
doc: remove ewoks_logo.png. Replaced by ewoks-log.svg
payno Jun 9, 2026
963574b
doc/conf.py: remove overwrite of navbar_start (useless)
payno Jun 9, 2026
e8cac28
doc - ewoks icon: integrate "circle" style in addition of path.
payno Jun 9, 2026
e1c61ac
doc: update ewoks icon to use an url instead of a local file.
payno Jun 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,12 @@
"url": "https://pypi.org/project/ewoksutils",
"icon": "fa-brands fa-python",
},
{
"name": "ewoks",
"url": "https://ewoks.readthedocs.io/en/stable",
"icon": "https://gitlab.esrf.fr/workflow/ewoksadmin/ewoksdoc/-/raw/main/logos/ewoks_for_sphinx_theme.svg", # This svg contains dark / light mode information
"type": "local",
},
Comment on lines +65 to +70

@payno payno Jun 9, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

This is adding the icon

@loichuder loichuder Jun 9, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

So other projects will take an URL to this icon?

@payno payno Jun 9, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

No the idea was to have a file locally.
We could have an url but it would be on the https://gitlab.esrf.fr/workflow/ewoksadmin/ewoksdoc/ I guess.

@loichuder loichuder Jun 9, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Yes, I think it would be easier to have an URL in ewoksdoc to avoid adding the file in every project

@payno payno Jun 9, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I give it a quick test but when switching to url then the image url is only "reported"

<img width="653" height="98" alt="image" src="https://github.com/user-attachments/assets/b610cc2d-8103-48d5-b22d-e4da44c30ce6" />

So this way works for .png for example but my browser is blocking the rendering when using .svg. It seems to comes from the way the server is serving the file... for security reasons but to be honest this is where my expertise stops. Maybe you have more knowledge / hint on this @loichuder ?

And as we have the handling of the theme switching to .png or other file format will not be sufficient.

@woutdenolf woutdenolf Jun 9, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

So this would work

{
    "name": "ewoks",
    "url": "https://ewoks.readthedocs.io/en/stable",
    "icon": "https://ewoks.esrf.fr/en/latest/_static/ewoks-link-icon.png",
    "type": "url",
}

but this would fail

{
    "name": "ewoks",
    "url": "https://ewoks.readthedocs.io/en/stable",
    "icon": "https://ewoks.esrf.fr/en/latest/_static/ewoks-link-icon.svg",
    "type": "url",
}

Is that the point? Weird.

@loichuder loichuder Jun 9, 2026 •
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Works on my end with

{
    "name": "ewoks",
    "url": "https://ewoks.readthedocs.io/en/stable",
    "icon": "https://raw.githubusercontent.com/ewoks-kit/ewoksutils/refs/heads/81-documentation-add-an-icon-that-links-to-the-main-documentation/doc/_static/ewoks-logo.svg",
    "type": "url",
},

@payno payno Jun 9, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

So this would work

{
    "name": "ewoks",
    "url": "https://ewoks.readthedocs.io/en/stable",
    "icon": "https://ewoks.esrf.fr/en/latest/_static/ewoks-link-icon.png",
    "type": "url",
}

but this would fail

{
    "name": "ewoks",
    "url": "https://ewoks.readthedocs.io/en/stable",
    "icon": "https://ewoks.esrf.fr/en/latest/_static/ewoks-link-icon.svg",
    "type": "url",
}

Is that the point? Weird.

Yes exactly. And the examples they are provided about this is outdated. I hope the 'web experts' will be able to provide some input. It could be for security reason (but as I said I don't have expertise on this) This is more an observation but I was not able to have my finger on the clear explanation.

@loichuder loichuder Jun 9, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

It seems that you can't use https://github.com to access the file since some cookies seem to be included. Using https://raw.githubusercontent.com/ works fine though.

@loichuder loichuder Jun 10, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Note for future reference for Gitlab: we have to use https://gitlab.esrf.fr/.../-/raw/main/... instead of https://gitlab.esrf.fr/.../-/blob/main/...

],
"logo": {
"text": docstitle,
Expand Down
Loading