Whisperscope is a tool for scraping textual data out of languages with
C-style comments, and provides basic autodocumentation functionality
targeting Sphinx.

It makes absolutely no assumptions about the structure of your code
whatsoever, and serves simply as a means of pulling markdown out of
comments and dumping it into Sphinx.  Works great for performing
autodocumentation on JavaScript projects.

Whisperscope does no syntax checking beyond comment recognition, so it
could theoretically be used for a lot of things.  Because of this, you
can also use it as a python module.
.


To install Whisperscope, download or checkout this repository, and run

 > sudo python setup.py develop

which will make a symlink to this project on your system path.  This
will install the command 'docshound', which is used to access
Whisperscope's auto-documentation functionality.

For more information about , see

 > docshound --help

Docshound requires pandoc, which on Fedora GNU/Linux may be installed
via the 'pandoc' package.  More info on pandoc is available here:
http://bfroehle.com/2013/04/26/converting-md-to-rst/
.


For an example of usage and output, this page:
http://pirateradiotheater.org/files/m.grl/sphinx_docs/api_reference/m.media.html
was generated by this code:
https://github.com/Aeva/m.grl/blob/master/src/m.media.js
.


Whisperscope is free software, and is made available to you under the
General Public License version 3.0 or later.  See LICENSE for more
information.  I love you all, and happy hacking!
.