Skip to main content

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

Project description

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

[![Travis-CI](https://img.shields.io/travis/ClimateImpactLab/sphinxscript/master.svg?style=flat-square "Travis CI")](https://travis-ci.org/ClimateImpactLab/sphinxscript)
[![PyPi](https://img.shields.io/pypi/v/sphinxscript.svg?style=flat-square "PyPi")](https://pypi.python.org/pypi/sphinxscript)
[![Coveralls](https://img.shields.io/coveralls/delgadom/sphinxscript.svg?style=flat-square "Coveralls")](https://coveralls.io/github/ClimateImpactLab/sphinxscript)

Produced by the [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::

sphinxscript



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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
sphinxscript-0.0.6-py2.py3-none-any.whl (7.4 kB) Copy SHA256 hash SHA256 Wheel py2.py3
sphinxscript-0.0.6.tar.gz (5.7 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page