arrow-wasm icon indicating copy to clipboard operation
arrow-wasm copied to clipboard

Published 20 hours ago • verified publisher icon domoritz

Generate documentation

Open domoritz opened this issue 4 years ago • 2 comments

Probably could use https://typedoc.org/.

domoritz avatar Jan 27 '21 13:01 domoritz

Just reading through your issues 😄... In my experience typedoc has worked really well! Write docstrings in Rust, they're transpiled into .d.ts files automatically by wasm-pack, and then work basically out of the box with typedoc. Example here: https://kylebarron.dev/parquet-wasm/

Just needed a custom tsconfig plus declaring .d.ts files in the typedoc's entryPoints config. https://github.com/kylebarron/parquet-wasm/blob/8a5b5f0e01439c050a123597b2a26d01174703c8/typedoc.json https://github.com/kylebarron/parquet-wasm/blob/8a5b5f0e01439c050a123597b2a26d01174703c8/tsconfig.docs.json

kylebarron avatar Mar 29 '22 18:03 kylebarron

Sweet. I think someone needs to revive this project first and update it to the latest arrow package/do some perf improvements but then docs would be nice. Awesome to hear it should just work.

domoritz avatar Mar 29 '22 21:03 domoritz