Adding use of Sphinx documentation

GaboFDC commented 8 years ago

I ran the sphinx-quickstart script and made some minor changes. Added an initial structure with readme, changelog and the modules. Edited the docstrings in the modules for correct visualization. Generated the html files, in the dir above Sphinx. Y tried to send them to a gh-pages branch but wasn't sure of how to do it right, so I leave them there.

rdegges commented 8 years ago

Thanks for the PR! Sorry for being so late to review this.

Would you mind making a few changes?

Please add a rule to the .gitignore file to ignore all built files (anything in the html directory). I don't think those pre-built files should be part of the git rules as they are just assets.
Remove the make.bat file that sphinx-quickstart autogenerates. This file is used to build the project on Windows, and since Asterisk only runs on *nix (afaik), this is unneceesary.

If you update that PR I'd be happy to merge and also host the docs! TY!

GaboFDC commented 8 years ago

Done, please review @rdegges

rdegges commented 8 years ago

Looks good!

jfernandz / pyst2

Adding use of Sphinx documentation #22