update or overhaul documentation

[mikofski]

Problem

The documentation is terse and difficult to use for native MATLAB users unfamiliar with Python and Sphinx. There also aren't readthedocs or github.io pages, and the README is too simple. For example, some users probably don't know that they can generate all of the source pages automatically by calling apidoc. Also perhaps some MATLAB users don't realize they can use Napolean or NumPyDoc style to document functions and class arguments that doesn't drastically differ from the style they currently use. And some MATLAB users who are unfamiliar with Python and Sphinx documentation may not realize the advantage of documenting their methods this way so that Sphinx creates a searchable index and links. Some MATLAB users may also be unfamiliar with restructured text markup.

See the library.io list of projects that use the Sphinx contrib MATLAB domain and you can get a flair for how they are or are not using it.

Proposal

Create a readthedocs or github.io pages that are written specifically for MATLAB users who are unfamiliar with Python and Sphinx documentation.

[joeced]

Started working on this in https://github.com/sphinx-contrib/matlabdomain/tree/develop/0.4, current result can be seen on https://sphinxcontrib-matlabdomain.readthedocs.io/en/develop-0.4/.

Still work in progress :)