sphinxcontrib-autoanysrc 0.0.1-20141119

Install

pip install sphinxcontrib-autoanysrc

Usage

Add autoanysrc to extensions list:

extensions = ['sphinx.ext.autodoc', 'sphinxcontrib.autoanysrc', ]

Example of usage:

.. autoanysrc:: directives
    :src: app/**/*.js
    :analyzer: js

Where:

• src option is the pattern to list source files where docs are stored

• analyzer option to determine witch analyzer must be used for processing this files

Directive will iterate over app/**/*.js files and process it line by line.

JSAnalyzer

Search comments blocks starts by /*””” and ends by */ (inspired by Nuulogic/sphinx-jsapidoc).

For example services.js:

/*"""
Services
````````

The function :func:`someService` does a some function.
*/

function someService(href, callback, errback) {
/*"""
.. function:: someService(href, callback[, errback])

    :param string href: An URI to the location of the resource.
    :param callback: Gets called with the object.
    :throws SomeError: For whatever reason in that case.
    :returns: Something.
*/
    return 'some result';
};

TODO

• encoding option

• allow internal indent in comment block

• registering custom analyzers from settings

• generate signatures like ext.autodoc…