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.

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

Jump to bottom

Improve documentation #22

Open
1 of 4 tasks
thomasgudjonwright opened this issue Aug 20, 2021 · 1 comment
Open
1 of 4 tasks

Improve documentation #22

thomasgudjonwright opened this issue Aug 20, 2021 · 1 comment

Comments

@thomasgudjonwright
Copy link
Member

thomasgudjonwright commented Aug 20, 2021 •
edited

To add:

  • API.md
  • example.md
  • Update README
  • more...?
@willtebbutt
Copy link
Member

On this, it would be good to get the examples set up using Literate.jl, in the same way that we do in e.g. KernelFunctions.jl, so that they're built when the docs are built (meaning we find out if they break when we make changes), they can be embedded in the docs, and the code to generate them is reviewable.

Definitely doesn't have to be done today.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@willtebbutt @thomasgudjonwright