mapbox / node-cpp-skel

Skeleton for bindings to C++ libraries for Node.js using node-addon-api
Creative Commons Zero v1.0 Universal
72 stars 10 forks source link

Remove documentation.js dependency? #49

Closed mapsam closed 7 years ago

mapsam commented 7 years ago

The documentation.js dependency is very large ~116.5 MB when installed. I think we should remove this dependency from being installed automatically and only install it within the npm run docs script itself.

Would look like this:

"docs": "npm install documentation && documentation build src/*.cpp src/standalone_async/*.cpp src/standalone/*.cpp --polyglot -f md -o API.md"

cc @springmeyer @GretaCB

GretaCB commented 7 years ago

hey @mapsam , your example above is what the skel used to have before last week. Also, per chat last week, we discovered that the skel didnt have documentation.js as a dep in package.json.

I've since added this step as part of the docs https://github.com/mapbox/node-cpp-skel#installation.

mapsam commented 7 years ago

:facepalm:

Sorry @GretaCB totally blanked. I'm working on the cf branch which hasn't been updated with master in a while. Please disregard!