sphinxscript 0.0.5

Tool for building restructured text documentation for projects with scripts in many languages

sphinx-script Script Documentation Module
=========================================

version number: 0.0.5
author: [Climate Impact Lab](http://impactlab.org)

Overview
--------

Tool for building restructured text documentation for projects with scripts in many languages

Installation
------------

To install use pip:

$ pip install sphinxscript


Or clone the repo:

$ git clone https://github.com/ClimateImpactLab/sphinxscript.git
$ python setup.py install

Usage
-----

Set up your repository using sphinx. Near the top of the `conf.py` configuration
file, place the following lines:


import sphinxscript
sphinxscript.build_docs()

Finally, in your sphinx index file `index.rst`, include the following:

.. toctree::
:maxdepth: 4

[project_folder_name]

replacing `[project_folder_name]` with the name of the directory containing your
source code.


Using Sphinx-script with ReadTheDocs
------------------------------------

Include `sphinxscript` in the file `requirements.txt` in your root project
directory. Then follow the usage steps above.



Contributing
------------

TBD

Example
-------

TBD