Skip to content

Make docs logo into a copy instead of a symlink #366

Merged
ChrisRackauckas merged 1 commit intoSciML:mainfrom
abhro:logo-2
May 5, 2026
Merged

Make docs logo into a copy instead of a symlink #366
ChrisRackauckas merged 1 commit intoSciML:mainfrom
abhro:logo-2

Conversation

@abhro
Copy link
Copy Markdown
Contributor

@abhro abhro commented May 4, 2026

Checklist

  • Appropriate tests were added
  • Any code changes were done in a way that does not break public API
  • All documentation related to code changes were updated
  • The new code follows the contributor guidelines, in particular the SciML Style Guide and COLPRAC.
  • Any new documentation only uses public API

Additional context

Turns out symlinks fail on deploying docs builds, so just copy it over manually every time

Comment thread docs/make.jl Outdated
Comment on lines +7 to +9
# Copy the logo from root assets to doc assets folder so that Documenter can use
# it as favicon/sidebar logo
cp("./assets/logo.png", "./docs/src/assets/logo.png", force = true)
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.

Why not just put it there?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Just to keep it in sync with the main logo file, should that get updated. I was following from SciML's practice of Project.toml and Manifest.toml files, but if the logo is expected to be static, I can definitely push a commit that just makes the symlink into a copy instead. 👍

@abhro abhro changed the title Copy over docs logo to assets dir on build Make docs logo into a copy instead of a symlink May 4, 2026
@ChrisRackauckas ChrisRackauckas merged commit 90d7b82 into SciML:main May 5, 2026
15 of 17 checks passed
@abhro abhro deleted the logo-2 branch May 5, 2026 00:01
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.

2 participants