Hi Cian
Thanks for asking. Yes, it'd be *awesome* if Extempore had better API
docs.
As well as the sphinx docs in `docs/`, Pete Davis and I did actually do
some work a while on a searchable API doc website (which is what the
@param annotations are for). I'm not sure what state that's in right
now, but I'll check and get back to you asap.
There are a few different needs for Extempore docs at the moment:
1. keeping the sphinx docs (which power <
http://digego.github.io/extempore/>) up-to-date
2. adding longer-form "guides" for the new user trying to do various things
3. searchable, (reasonably) comprehensive API docs for the stdlib at least (this is the thing I mentioned above)
4. adding docs for *new* functionality which isn't documented anywhere
point 4 is probably best left to Andy and I at the moment, but there's
certainly potential for doing the other ones, depending on what you're
most interested in/familiar with.
Cheers,
Ben
Cian O'Connor <
cian.o...@gmail.com> writes:
> Currently there don't seem to be any API docs for Extempore. I'd like to
> try and at least make a start at documenting them. Has there been any
> thought previously about this. In particular:
>
> - Automatic generation tools (currently some of the library code seems
> to use things like @param which is a JavaDoc convention)?
> - Preferred documentation tool (Sphinx?)
> - Organization/Arrangement?