https://github.com/niess/turtle-docs
API documentation for the TURTLE library
https://github.com/niess/turtle-docs
Last synced: 2 months ago
JSON representation
API documentation for the TURTLE library
- Host: GitHub
- URL: https://github.com/niess/turtle-docs
- Owner: niess
- License: mit
- Created: 2018-07-23T09:02:25.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-03-27T16:39:40.000Z (about 2 years ago)
- Last Synced: 2025-02-01T19:14:21.856Z (4 months ago)
- Language: Shell
- Homepage: http://niess.github.io/turtle-docs
- Size: 198 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: COPYING.LESSER
Awesome Lists containing this project
README
# API documentation for the TURTLE library
( **T**opographic **U**tilities for t**R**ansporting par**T**icules over
**L**ong rang**E**s )
## Description
This is an HTML documentation of the [TURTLE][TURTLE] library API. The [latest
build](https://niess.github.io/turtle-docs) is available from GitHub pages.
The documentation is automatically generated from a
[Docurium](https://github.com/niess/docurium) fork.
## Usage
Clone the present repository, e.g. as:
```bash
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](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:
```bash
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](LICENSE) and [COPYING.LESSER](COPYING.LESSER) files.
[TURTLE]: http://niess.github.io/turtle