search

nglviewer / ngl

WebGL protein viewer
http://nglviewer.org/ngl/
MIT License
667 stars 170 forks source link

Rebuild of documentation #617

Open harryjubb opened 5 years ago

harryjubb commented 5 years ago

The build for the automated documentation is for quite an old version now (1.0.0-beta7). Are there any plans to update it to cover the latest release? If it's PR-able, happy to help.

@fredludlow @jamesfoley

fredludlow commented 5 years ago

npm run doc currently fails for me with typescript errors. I can have a look at those and try and fix it. @arose - assuming we get the doc command working, how easy is it to update the website?

arose commented 5 years ago

Last time I tried typedoc would not handle the typescript version NGL was written in. Maybe things are better now. I can update the website if the doc cmd is working again.

bergwerf commented 4 years ago

I was also unable to build the documentation. This is the output I got: https://pastebin.com/Dsxb7Btx All errors in THREE and ngl.

arose commented 4 years ago

typdoc needs to be updated, the version used in NGL is not compatible with the TS version used in NGL.

bergwerf commented 4 years ago

I can confirm that updating typedoc to the latest version and adding allowSyntheticDefaultImports (to import @types/promise-polyfill/index) to the tsconfig indeed fixes documentation generation. I can create a PR with just this but I also saw a few other dependencies need to be updated (some deprecation warnings and things moving to a different package). Is it helpful if I create a PR with some npm update and dependency changing, or might that break things?

fredludlow commented 4 years ago

@bergwerf - I'd be very happy with either option, if you can get deps updated cleanly then that'd be brilliant, if not then just getting the docs done would be very helpful.

bergwerf commented 4 years ago

There is also https://github.com/arose/ngl/pull/726 but that doesn't cover typedoc.