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

Documenter.jl Documentation? #37

Open
haberdashPI opened this issue Apr 7, 2018 · 1 comment
Open

Documenter.jl Documentation? #37

haberdashPI opened this issue Apr 7, 2018 · 1 comment

Comments

@haberdashPI
Copy link
Contributor

Just noticed that currently the documentation consists of the README and docstrings for functions. Thought it might be useful to have an issue to track adding some docs with Documenter.jl. I imagine some of the work I've done for Sounds.jl can be pulled over and combined with some of the content in the README.

Probably want to wait until the API is settled to work on this (and figured out which parts go in AudioIO.jl and which go in SampledSignals.jl).

@ssfrr
Copy link
Collaborator

ssfrr commented Apr 7, 2018

Yeah, definitely 👍 to Documenter docs. Maybe once the API shakes out we can do a doc blitz.

It might be nice to combine the docs somehow to show how the different packages are used together (though still keeping API references for each package from the docstrings). A while ago I registered http://juliaaudio.org and currently it just redirects to the GitHub organization, but that would be a nice place for the overview to live.

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