[chuck-users] example using ckdoc?

[Ge Wang]

Hi Michael!

Nestled in the source distribution is the script that generates the new 
ChucK API Reference:

the script:
https://github.com/ccrma/chuck/blob/main/src/scripts/ckdoc/gen-all.ck

the output:
https://chuck.stanford.edu/doc/reference/

the current CKDoc API:
https://chuck.stanford.edu/doc/reference/utils.html#CKDoc

It can generate docs on a single type, a group of types, or a group of 
groups (the new ChucK API reference is the latter.) So far, only HTML 
output is implemented, but CKDoc has been structured to support 
additional formats (JSON, Markdown, text).

While it is possible to use CKDoc to generate documentation on any ChucK 
type (including chugins and user-defined classes), it is still early and 
there are some hard-coded output tailored to the ChucK website. However, 
we are planning to make CKDoc increasingly more general and customizable 
so that it can be easily used by anyone to publish API documentation for 
chugins/libraries (like LiCK; thank you Michael!). Please let us know 
how we can improve CKDoc moving forward!

(Also on the roadmap: a package manager for chuck...)

Ge!

On 5/19/23 9:00 AM, Michael Heuer wrote:
> Hello,
> 
> Is there an example of using ckdoc?  Ideally a pointer to the script 
> that does it for ChucK itself ;)
> 
> Cheers,
> 
>     michael
> 
> 
> On Thu, May 18, 2023 at 2:31 PM Ge Wang <ge at ccrma.stanford.edu 
> <mailto:ge at ccrma.stanford.edu>> wrote:
> 
>     Dear all,
> 
>     A new release of ChucK (1.5.0.0; codename "chai") is here:
> 
>     https://chuck.stanford.edu/ <https://chuck.stanford.edu/>
>     https://chuck.cs.princeton.edu/ <https://chuck.cs.princeton.edu/>
> 
>     This is a major release; additions and updates include:
> 
>     * ChucK + AI (ChAI) -- a set of AI/ML tools for building interactive AI
>     musical instruments and systems (thanks to Dr. Rebecca Fiebrink for
>     blazing the trail on interactive AI for music; thanks Yikai Li and the
>     students of Music AI):
>     https://chuck.stanford.edu/chai/ <https://chuck.stanford.edu/chai/>
>     https://chuck.stanford.edu/doc/reference/ai.html
>     <https://chuck.stanford.edu/doc/reference/ai.html>
> 
>     * WebChucK IDE -- code ChucK on the web!
>     https://chuck.stanford.edu/ide/ <https://chuck.stanford.edu/ide/>
>           (thanks Terry Feng + team for WebChucK IDE)
> 
>     * WebChucK landing page (use ChucK in your web projects)
>     https://chuck.stanford.edu/webchuck
>     <https://chuck.stanford.edu/webchuck>
>           (thanks Jack Atherton for creating WebChucK)
> 
>     * all new API reference, now auto-generated from the type system (based
>     on Spencer Salazar's 'ckdoc' utility; many thanks to everyone who
>     contributed documentation and examples):
>     https://chuck.stanford.edu/doc/reference/
>     <https://chuck.stanford.edu/doc/reference/>
> 
>     * audio drivers support -- ASIO and WASAPI support on Windows; can now
>     compile Jack + Pulse + ALSA support into a single chuck executable on
>     Linux (thanks Dana Batali and Nick Shaheed)
> 
>     * improved audio devices support, including AirPods and other Bluetooth
>     headphones
> 
>     * The full list of new features and updates can found here:
>     https://chuck.stanford.edu/release/VERSIONS
>     <https://chuck.stanford.edu/release/VERSIONS>
> 
>     * (extra!) A few projects made with ChAI from a recent course
>     https://ccrma.stanford.edu/courses/356/
>     <https://ccrma.stanford.edu/courses/356/>
>     https://ccrma.stanford.edu/courses/356/gallery/
>     <https://ccrma.stanford.edu/courses/356/gallery/>
> 
>     Happy ChucKing to all!
>     ChucK Team
> 
>     [Many people contributed to chuck-1.5] Perry Cook, Spencer Salazar,
>     Jack
>     Atherton, Celeste Betancur, Chris Chafe, Michael Mulshine, Andrew Zhu
>     Aday, Marise van Zyl, Terry Feng, Nick Shaheed, Alex Han, Eito
>     Murakami,
>     Yikai Li, Ge Wang
> 
>     [Additional thanks] Dana Batali, David Braun, Barak Pearlmutter, Eric
>     Heep, Fernando Lopez-Lezcano, Kunwoo Kim, Stanford HAI, people of CCRMA
> 
>     ~~~
>     Ge Wang
>     Associate Professor
>     Center for Computer Research in Music and Acoustics (CCRMA)
>     Department of Music (also Computer Science, by Courtesy)
>     Stanford University
>     https://ccrma.stanford.edu/~ge/ <https://ccrma.stanford.edu/~ge/>
>     ~
>     Artful Design: Technology in Search of the Sublime!
>     -- what we make, makes us --
>     https://artful.design/ <https://artful.design/>
>     ~~~
>     _______________________________________________
>     chuck-users mailing list
>     chuck-users at lists.cs.princeton.edu
>     <mailto:chuck-users at lists.cs.princeton.edu>
>     https://lists.cs.princeton.edu/mailman/listinfo/chuck-users
>     <https://lists.cs.princeton.edu/mailman/listinfo/chuck-users>
> 
> 
> _______________________________________________
> chuck-users mailing list
> chuck-users at lists.cs.princeton.edu
> https://lists.cs.princeton.edu/mailman/listinfo/chuck-users