Generating documentation for specializers

1. Signup at Read the Docs.

2. Follow their instructions to import your Specializer repository.

3. Go to the advanced settings in your new project and enable use VirtualEnv so your package is installed during the build process and also add requirements.txt as your requirements file.

4. Execute the following commands.

   $ pip install Sphinx
   $ cd /path/to/project
   $ mkdir docs
   $ cd docs
   $ sphinx-quickstart
   $ make html
   $ cd ..
   $ sphinx-apidoc -o docs your_module
   $ git add docs
   $ git commit -m "Adding sphinx generated apidocs"

5. Add a requirements.txt file to your repository listing any dependencies for your project to be installed. I.e.

   ctree
   numpy>=1.8.1
   

6. Add the Read the Docs Post Commit Hook to the after-success: section of your .travis.yml. It should look something like this

   ...
   after-success:
     ...
     # Post Commit Hook
     - curl -X POST http://readthedocs.org/build/you_project_name
     ...