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

Documentation #88

Open
janden opened this issue Jan 29, 2021 · 3 comments
Open

Documentation #88

janden opened this issue Jan 29, 2021 · 3 comments

Comments

@janden
Copy link
Collaborator

janden commented Jan 29, 2021

How far do we want to go with this? I don't know if it's worth it to have a full-fledged site lite for Finufft, but something more substantial (like a tutorial or something) than in-code documentation might be a good idea.

@ahbarnett
Copy link
Collaborator

I think a examples.md viewable in github will be better than a full readthedocs separate site, which is annoying to set up.

@ahbarnett
Copy link
Collaborator

ahbarnett commented Feb 5, 2021

1566aaf made the README better for docs, pointing to docs in the source code, which are decent (and I cleaned up). It's ok for now, but would be better to move (note: not copy, since we want SSOT) to a separate user-facing *.md, remembering to point to it from the source code. I won't close, but it's less urgent now.

@ahbarnett
Copy link
Collaborator

9004b26 does the above - decent C++ function docs - apart from no tutorial.

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

No branches or pull requests

2 participants