samkearney / esta-ngl

ESTA Next-Gen Library data model documentation

THIS REPOSITORY HAS MOVED!

The new location of the repository is https://gitlab.com/skearney/udr-docs. The new rendered webpage is https://udr-docs.com. Note that these locations are currently accessible to ESTA Next-Gen Library Task Group members only.

ESTA Next Generation Entertainment Control Model: Uniform Device Representation (UDR)

This repository houses working documentation for ESTA's Next Generation Entertainment Control Model: Uniform Device Representation (UDR), which is developed by the ESTA TSP's Next-Gen Library Study Group. UDR is currently an early work-in-progress and actively being worked on by the study group. Everything in this documentation is subject to change without notice.

The Next-Gen Library study group is working toward defining a standardized method of describing entertainment equipment in a machine-readable way, such that it can automatically be discovered and controlled by control and configuration software.

Documentation Output

The docs are served on the GitHub Page associated with this repository.

Docs are rebuilt automically from the master branch.

Building the Documentation

The documentaton is currently written in reStructuredText and converted to HTML with Sphinx. To build the documentation, you will need to install Python. You will also need a make tool of some kind.

Once python is installed, you can install Sphinx and the other dependencies of the documentation by referencing the requirements.txt file at the root of this repostiory:

pip install -r requirements.txt

Then cd into the docs/ directory and build the documentation using:

make html

The HTML documentation will be output to the docs/_build directory.

reStructuredText

There is a good primer on the reStructuredText flavor used with Sphinx here.