README

This repository links to the Tilia Manual which support the Tilia software.

Author:

Simon Goring Neotoma Development Team

This work is funded through support to the Neotoma Project through NSF Geosciences (award number pending).

We welcome contributions from any individual, whether code, documentation, or issue tracking. All participants are expected to follow the code of conduct for this project.

License:

The original documentation herein is licensed under an MIT license. This Documentation makes use of Sphinx and ReStructuredText. Sphinx is licensed under a BSD license.

Development

The manual is scripted using plain-text files with ReStructuredText markdown all saved in the docs folder (with an rst extension). readthedocs uses a workflow where documents generated in rst files are then compiled to HTML using a Python parser called Sphinx to generate the documentation. Once the file is compiled it is then pushed up to the GitHub repository (you're here now) and is then cloned & re-compiled by readthedocs, where it becomes available at

Currently the files within the manual are structured (somewhat) hierarchically:

• index.rst : The header for the documentation. Compiles here. Contains the Acknowledgements and the Table of Contents. Acts as a simple homepage for the Manual.
• get_tilia.rst : Downloading & Installation instructions for Tilia. Compiles here
• creating : How to create a new Tilia file. Compiles here
• overview.rst : Presumes that a file has been generated. An overview of an empty Tilia file. Compiles here
• edit_data.rst : How to go about editing a Tilia file. Both practical and best-practices. Compiles here
• tools.rst : Still a stub. This is intended to present the various features of Tilia that aren't part of the core editing process. Compiles here
• steward.rst : Proposed but not developed.