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

ENH - Add logo and favicon to docs #114

Merged
merged 11 commits into from
Dec 3, 2024
Merged

Conversation

trallard
Copy link
Contributor

@trallard trallard commented Nov 26, 2024

!NOTE
I started this PR off the branch in #65, so that PR must be merged before this one

This PR:

  • Moves the logo and favicon one level up in the _static directory so that this can be rendered by Sphinx book
  • Updates the paths to the favicon and logo on the landing page
  • Changes the URL to the tutorial to relative URLs (was pointing to the built RTD docs)
  • Updates the contribution guidelines to point to the right source directory
  • Removes some accidentally checked files (doctrees)

🔗 Link to PR preview: https://jax-ai-stack--114.org.readthedocs.build/en/114/

Copy link
Contributor

@pavithraes pavithraes left a comment

Choose a reason for hiding this comment

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

Thanks, Tania. Looks good to me. :)

@jakevdp
Copy link
Collaborator

jakevdp commented Dec 2, 2024

What's the purpose of moving all the files here? This is going to cause conflicts with every other in-flight PR, so I'd lean toward not merging this change.

Can we add the logo and favicon without modifying the file structure of the repo?

@jakevdp jakevdp self-assigned this Dec 2, 2024
@trallard
Copy link
Contributor Author

trallard commented Dec 2, 2024

I actually branched off #65

Which added the logo, styling, the landing page and changes the docs structure - I am unsure why that change was made there, but I assumed that had been discussed when opening #65.

We can add the logo and favicon without changing the structure of the repo but we'd need to then revert the changes in #65 for this purpose.

@jakevdp
Copy link
Collaborator

jakevdp commented Dec 2, 2024

Ah, got it. In that case we need to wait for #65 to be merged, at which point we can rebase this and the diff should be small.

@jakevdp jakevdp closed this Dec 2, 2024
@jakevdp jakevdp reopened this Dec 2, 2024
@jakevdp
Copy link
Collaborator

jakevdp commented Dec 3, 2024

OK, the style update is merged. Can you rebase this? Thanks!

@trallard trallard force-pushed the trallard/patch-logo branch from 3262bb2 to 6dcf33f Compare December 3, 2024 21:51
@trallard
Copy link
Contributor Author

trallard commented Dec 3, 2024

@jakevdp this is ready to merge.

Also while building locally I noticed the Note on the tutorials index so I changed to an admonition to make it more noticeable

image

Copy link
Collaborator

@jakevdp jakevdp left a comment

Choose a reason for hiding this comment

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

Thanks!

@jakevdp jakevdp merged commit 0229143 into jax-ml:main Dec 3, 2024
6 checks passed
@trallard trallard deleted the trallard/patch-logo branch December 3, 2024 22:28
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.

4 participants