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
=========================================
[![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.
Source Distribution
sphinxscript-0.0.6.tar.gz
(5.7 kB
view hashes)
Built Distribution
Close
Hashes for sphinxscript-0.0.6-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2a16448d6458c4f9631b71bc77317156f9d58093d233224d0e63c6cd756a514c |
|
MD5 | 15cb57a34f93dfc1f15cd6bb913bf8a6 |
|
BLAKE2b-256 | abc1a8b4eb88674cdcdc658986c478958883942f60f7594f47803affe1662f48 |