niess/turtle-docs

API documentation for the TURTLE library

API documentation for the TURTLE library

( Topographic Utilities for tRansporting parTicules over Long rangEs )

Description

This is an HTML documentation of the TURTLE library API. The latest build is available from GitHub pages. The documentation is automatically generated from a Docurium fork.

Usage

Clone the present repository, e.g. as:

cd turtle && git clone https://github.com/niess/turtle-docs.git docs

Then one can navigate the local content by directing a browser to the docs/index.html file. Note that with some browsers, e.g. chrome, you'll need to explicitly serve the file using a local HTTP server. For example, using Python:

cd docs/docs
python -m SimpleHTTPServer 8000

Then direct your browser to localhost:8000.

License

The TURTLE library is under the GNU LGPLv3 license. See the provided LICENSE and COPYING.LESSER files.