alexxnica / documentation-1

LaMetric Time Developer Documentation

LaMetric Time Developer Documentation

This is the repository for the public LaMetric Time developer documentation available here.

This documentation is written using reStructuredText, powered by Sphinx, and hosted on ReadTheDocs.

Building the docs

Install Software

1. Install python and pip.
2. Install sphinx and sphinx-autobuild pip install sphinx shpinx-autobuild
3. Install sphinx-rtd-theme pip install sphinx_rtd_theme
4. Install recommonmark sudo pip install recommonmark

Follow these steps to build the documentation locally:

1. Open terminal and cd to the project folder
2. Build HTML: $ make html
3. Open _build/html/index.html in a web browser.

To see the available make targets, simply execute make.

Contributing

If you find a typo, error, or think something can be communicated better, fork this repository and make a pull request.

Contact

You can reach us at mailto:[email protected] with any feedback or questions.