Sphinx and JavaScript Documentation Workflow [clos

Question

For my JavaScript framework I would like to use Sphinx. Since I am new in the sphinx world I would like you people to help me out getting started with Sphinx and JavaScript.

Any help appreciated.

Best Regards

Answer 1

I believe you're looking for Sphinx' JavaScript Domain feature.

Edit: From a quick glean at the documentation & tools, it doesn't look like you can use ReST inside your JavaScript. You'll either have to fish out the documentation from the comments, or keep it around in sidecar-files.

Answer 2

Sorry for too late response )

Like you I want build docs for my own JS framework based on AngularJS.

And like oliverseal, I am built sphinx extension in native way for sphinx and ext.autodoc sphinxcontrib-autoanysrc

It simple and clean, but does have ext.autodoc features for auto generation signatures and others, but it enough for me store reST docs of framework API in js files )

You can implement ext.autodoc features with sphinxcontrib-autoanysrc extension check out autoanysrc.JSAnalyzer