Add docs website and revamp README - Githubissues

SciML / ADTypes.jl

Repository for automatic differentiation backend types

https://sciml.github.io/ADTypes.jl/

MIT License

38 stars 11 forks source link

Add docs website and revamp README #28

Closed gdalle closed 6 months ago

gdalle commented 6 months ago

Checklist

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

Additional context

Add docs folder with make.jl and src
Put the public and private API reference in src/index.md
Add Documentation.yml workflow taken from https://documenter.juliadocs.org/dev/man/hosting/#GitHub-Actions
Revamp README
Add badges to README

I have also configured the SSH deploy keys in the repo with DocumenterTools, as described in https://documenter.juliadocs.org/dev/man/hosting/#travis-ssh