Add JavaScript documentation with sphinx-js

yeatmanlab / AFQ-Browser

Browser-based visualization tools for AFQ results

BSD 3-Clause "New" or "Revised" License

33 stars 15 forks source link

Add JavaScript documentation with sphinx-js #221

Closed anotherjoshsmith closed 6 years ago

anotherjoshsmith commented 6 years ago

Adds JavaScript API section in our documentation. Each function in the custom JavaScript files is now decorated with a JSDoc-style comment where we can describe the function. A new reStructuredText file has been added for each custom JavaScript file for auto-documentation with sphinx-js.

anotherjoshsmith commented 6 years ago

@richford Fixed the Travis issue. Merge at will! I can take care of documenting tract-details.js and sortable-tables.js (which we'll rename to plot.js and table.js soon) if you want to take care of 3d-brain.js and save-settings.js.