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

Update readme #439

Merged
merged 2 commits into from
Oct 24, 2022
Merged

Update readme #439

merged 2 commits into from
Oct 24, 2022

Conversation

mcabbott
Copy link
Member

This adds a link to the docs, and the logo, to the readme.

Matches https://github.com/FluxML/Optimisers.jl


[docs-stable-img]: https://img.shields.io/badge/docs-stable-blue.svg
[docs-stable-url]: https://fluxml.ai/NNlib.jl/stable/
Copy link
Member

Choose a reason for hiding this comment

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

Will this work once we tag a new version?

Copy link
Member Author

Choose a reason for hiding this comment

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

Oh I don't know, I copied from Optimisers where it also doesn't work.

Copy link
Member

@ToucheSir ToucheSir Oct 24, 2022

Choose a reason for hiding this comment

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

Worth a try then I guess. Do you mind tagging after this is merged to test?

@mcabbott mcabbott merged commit a5e51ab into master Oct 24, 2022
@mcabbott mcabbott deleted the mcabbott-patch-2 branch October 24, 2022 16:23
@Saransh-cpp
Copy link
Member

Documentation for v0.8.10 was not generated, see - https://github.com/FluxML/NNlib.jl/actions/runs/3314804815/jobs/5474567079. Looks like there was a problem with DOCUMENTER_KEY.

Given that the tag exists now, the documentation workflow can be (re)triggered using -

Note
I am not sure if this would work without resolving the DOCUMENTER_KEY issue. Someone with push access to NNlib could try this!

git tag -a v0.8.10+docs -m "Build and deploy docs for v0.8.10 manually"
git push --tags

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.

3 participants