Skip to content

Latest commit

 

History

History
38 lines (26 loc) · 1.26 KB

README.rst

File metadata and controls

38 lines (26 loc) · 1.26 KB
Documentation Status

RIOS - Research Instrument Open Standard

Overview

This repository contains the source materials needed to produce the RIOS documentation site and specifications.

Contributing

Contributions to the RIOS specifications or this site specifically must be made by forking this repository, implementing your desired changes, and then submitting a Pull Request back to the project.

This site/specification is authored using the reStructuredText format within a Sphinx site configuration.

If you're working in a Python-capable environment, you can install the recommended toolset by using pip to install the requirements.txt file that is included in this repository.

Assuming the reccommended toolset is available, the full RIOS site can be generated by executing make html within the /docs/ directory in this repository. The output will be placed in /docs/build/html.