First cut at Javascript docs

Signed-off-by: Ian Bell <ian.h.bell@gmail.com>
This commit is contained in:
Ian Bell
2014-08-05 23:29:28 +02:00
parent 4fd84a7eba
commit aa3cade87d
2 changed files with 38 additions and 1 deletions

View File

@@ -0,0 +1,37 @@
.. _Javascript:
******************
Javascript Wrapper
******************
Users
=====
Precompiled binaries
--------------------
* Download the precompiled binaries from :sfdownloads:`Javascript`
* Load your js file into your website, following the structure of `the example here <https://github.com/CoolProp/CoolProp/blob/master/wrappers/Javascript/index.html>`_
Developers
==========
On linux, but binaries generated are cross-platform, follow the instructions from `emscripten.org <http://kripken.github.io/emscripten-site/docs/getting_started/downloads.html>`_ - download the portable emscripten SDK `emsdk` for linux.
1. Expand the SDK zip file
2. At the console in the folder that contains the file emsdk run the commands
emsdk update # This will fetch the list of things to download
emsdk install latest # This will download and install the full toolchain
3. Go enjoy a nice walk or a cup of coffee - it could be a while
4. Set the environmental variable ``EMSCRIPTEN`` to point to the root of the toolchain. For instance in your /etc/rc.local file you can add the line
export EMSCRIPTEN=/path/to/folder/containing/emsdk
5.

View File

@@ -15,7 +15,7 @@ __gitrevision__ = CoolProp.get_global_param_string(b'gitrevision')
def get(s):
"""
This is just a shorthand function for getting a parameter from
CoolProp.get_global_param_string
``CoolProp.get_global_param_string``
"""
return CoolProp.get_global_param_string(s)
def test():