Sphinx and JavaScript Documentation Workflow [closed]

Question

Closed. This question needs to be more focused. It is not currently accepting answers.

Want to improve this question? Guide the asker to update the question so it focuses on a single, specific problem. Narrowing the question will help others answer the question concisely. You may edit the question if you feel you can improve it yourself. If edited, the question will be reviewed and might be reopened.

Closed 7 years ago.

Improve this 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.

Morten Siebuhr · Accepted Answer · 2011-12-27 13:14:33Z

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.

edited Dec 27, 2011 at 13:14

answered Dec 27, 2011 at 13:00

Morten Siebuhr

6,1284 gold badges33 silver badges43 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

Software Enthusiastic Over a year ago

Thats fine, I dont want to use ReST inside my JavaScript library, it would be good if all the library members are automatically detected along with associated comments by the sphinx.

Morten Siebuhr Over a year ago

I don't quite follow; »auto-detect library« members and »associated comments by sphinx«? AFAIK, Sphinx doesn't know how to read JavaScript-code at all, so it can neither parse out functions or their associated documentation for you. That's why I suggested the use of sidecar files.

oliverseal Over a year ago

This is a delayed response on this, but I had been looking to see if someone else had done this. When I couldn't find anything, I just built something. github.com/Nuulogic/sphinx-jsapidoc I'd qualify it as alpha and it's very, very specific about the syntax you use -- It wants pure javascript. I have only tested it on the internal code for the company I work for, but it's working pretty solid for us.

estin · Accepted Answer · 2014-10-23 12:42:52Z

0

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

answered Oct 23, 2014 at 12:42

estin

3,1311 gold badge26 silver badges32 bronze badges

Collectives™ on Stack Overflow

Sphinx and JavaScript Documentation Workflow [closed]

2 Answers 2

3 Comments

Comments

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

3 Comments

Comments

Linked

Related