V8 auto docs

[Qard]

I'm trying to figure out a good way to add something to our release process to auto-generate the docs for deps/v8 and dump them somewhere online. The intent is to have a folder tree something like /docs/internals/v8/{node_version} where you can view V8 docs for the relevant node/io.js version.

Challenges:

• A single build is over 1GB.
• Requires doxygen is installed.
• Completion and accuracy of the API reference docs are unknown to me

Perhaps there could be a node service with doxygen and git already installed that watches github releases, checks out the matching commit, runs doxygen, and dumps the resulting files in S3 or something like that? Anyone have any feedback on this idea?

cc: @chrisdickinson

[distracteddev]

Does v8 publish these to a public site already?

[Qard]

No.

There are some not up-to-date versions of the docs hosted in various places around the internet, but nowhere that has versions matched to all the releases. The Node Source ones are the closest.

see:

• https://v8docs.nodesource.com
• http://izs.me/v8-docs/main.html
• https://github.com/thlorenz/v8-dox

[brendanashworth]

+1! I found this really useful when digging around in the source.

I've done some with doxygen over here at my repo: http://brendanashworth.github.io/v8-docs/

Here is the patch I use: brendanashworth/v8-docs@183baa6

[distracteddev]

Sounds good to me. If we're okay with the build-server idea, I/someone else can probably put a docker container together easily. Then we can decide where to host it.

[distracteddev]

Might be good to leave the tooling for later though and just for the first release do it manually and dump the folder into git

[Qard]

Here's the beginnings of the autodoc service: https://github.com/Qard/v8-autodoc

You just hit example.com/commit-hash-or-tag/* and it'll generate the docs for the V8 version from that particular commit. It's a bit rough at the moment, but it works.

[chad3814]

an automated system would be great, I've manually done most versions of node and io.js at http://v8dox.com/

(this is all non-automated and on github pages)

[Qard]

Would anyone care to review my code for the V8-autodoc service, and is there somewhere I can host this?

I'm a bit unsure what I think of the checkout-and-generate flow. It could be a DoS target, not sure how worried I should be about that risk here.

[Trott]

Closing as this repository is dormant and likely to be archived soon. If this is still an issue, feel free to open it as an issue on the main node repository.