Treora opened a new pull request #101: URL: https://github.com/apache/incubator-annotator/pull/101
Taking a stab at #97. It seems to work, but suggestions/improvements welcome. @tilgovi: you suggested [@microsoft/api-documenter](https://www.npmjs.com/package/@microsoft/api-documenter) may currently be easier to set up than tsdoc; I found this a bit of a hassle to set up too, with more configuration than I’d like, so feel free to suggest we give tsdoc another try if you prefer (also I’m not sure if the output would be better/worse). From my commit message: > It seems we manually need to run api-extractor before running > api-documenter; hence the bunch of configuration files. > > The packages each get their own documentation in packages/*/api/docs (I’m > not sure we need it per-package; if it could simplify configuration we > could just as well put it all into a single folder). > > Ideally, the 'apache-annotator' meta-package would contain the > documentation of all packages it exports. The "bundledPackages" option > seems to be made for this, but when used I get a ‘not implemented’ error > because of the `import * as … from …` syntax we use. (I already had to > modify the original `export * as … from …` because of a similar error) > I suppose we could leave it for the time being, and be satisfied with the > documentation of the individual (non-meta) packages.` If we merge this, a next step would be to run this build script from the website’s build script, and copy the results into the website. ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org
