You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I played around with typedoc for generating docs for rapids-js modules. Initial attempts were fairly unsatisfactory, but I stumbled across the new beta, which adds a "library mode" that is more suitable for projects like ours.
Some steps:
install typedoc beta (0.20)
npm install typedoc@beta
install babel template manually
Maybe a quirk on my system, I had to install this by hand
note that in previous versions --excludePrivate seemed to prevent attributes like _data from showing up, but they are still showing up for me when the beta is used.
The text was updated successfully, but these errors were encountered:
We have typedoc set up in Arrow and IxJS, and should be able to follow those examples. We can add an npm "doc" script to build the docs for each module, plus a typedoc.js config file to customize things.
I played around with typedoc for generating docs for rapids-js modules. Initial attempts were fairly unsatisfactory, but I stumbled across the new beta, which adds a "library mode" that is more suitable for projects like ours.
Some steps:
install typedoc beta (0.20)
install babel template manually
Maybe a quirk on my system, I had to install this by hand
run typedoc on a single module
note that in previous versions
--excludePrivate
seemed to prevent attributes like_data
from showing up, but they are still showing up for me when the beta is used.The text was updated successfully, but these errors were encountered: