Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Sphinx and JavaScript Documentation Workflow [closed]

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.

like image 382
Software Enthusiastic Avatar asked Dec 27 '11 12:12

Software Enthusiastic


1 Answers

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.

like image 165
Morten Siebuhr Avatar answered Oct 20 '22 00:10

Morten Siebuhr