cheminfo-js / spectra-data

Library to deal with spectra (IR, UV, ...), 1D NMR as well as 2D NMR
https://cheminfo-js.github.io/spectra-data
MIT License
4 stars 0 forks source link

Add documentation build and publish in package.json #18

Closed lpatiny closed 7 years ago

lpatiny commented 8 years ago

Get inspired

https://github.com/image-js/core/blob/d166bd5a0e6b493097c9feefd1ca7bf3903052c4/package.json#L37-L38

lpatiny commented 8 years ago

This should also lead to the suppression of documentation.md

lpatiny commented 8 years ago

In the dev-dependencies you may use the head of documentation.js

https://github.com/image-js/core/blob/d166bd5a0e6b493097c9feefd1ca7bf3903052c4/package.json#L65

maasencioh commented 8 years ago

@lpatiny why don't use cheminfo doc instead for the docs generation?

lpatiny commented 7 years ago

Indeed it will do the job.

So if you want to build and publish you should simply install the cheminfo-tools npm

npm install cheminfo-tools -g

And then

cheminfo doc -p

However I would expect it is available then on:

https://cheminfo-js.github.io/spectra-data

But this does not work. What I should do more ?

maasencioh commented 7 years ago

It's better to install the tools as global with npm install cheminfo-tools -g, but after it's generated the docs dir, you need to enable the pages from settings, I can't do this in this repo for permissions but here you have a post

lpatiny commented 7 years ago

Thanks Miguel. I updated my comment to add the '-g'. GH-pages Works perfectly. There is just some work to have the correct jsdoc format now ...