Geek Answers Handbook

Sphinx and JavaScript Workflow

For my JavaScript framework, I would like to use Sphinx. Since I'm new to the world of sphinxes, I would like you to help me get started with Sphinx and JavaScript.

Any help was appreciated.

Best wishes

+7
source share
2 answers

I believe you are looking for the Sphinx JavaScript Domain function.

Edit: From a quick list of documents and tools, it doesn't seem like you can use ReST in your JavaScript. You will either have to catch the documentation from the comments, or save it in sidecar files.

+1
source

Sorry for too late reply)

Like you, I want to create documents for my own AngularJS-based JS framework.

And, as oliverseal, I create the sphinx extension in the native for sphinx and ext.autodoc sphinxcontrib-autoanysrc

It is simple and clean, but has ext.autodoc functions for autogeneration signatures and others, but for me it is enough to store reST-documents of APIs in js files)

You can implement ext.autodoc functions with sphinxcontrib-autoanysrc autoanysrc.JSAnalyzer extension

0
source

More articles:


All Articles