Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tasrobotics/raidzero-training-docs

Training Documentation for Raid Zero 4253
https://github.com/tasrobotics/raidzero-training-docs

first-robotics-competition frc robotics

Last synced: about 20 hours ago
JSON representation

Training Documentation for Raid Zero 4253

Awesome Lists containing this project

README

        

![GitHub](https://img.shields.io/github/license/TASRobotics/RaidZero-Training-Docs?logo=Github)
![Website](https://img.shields.io/website?url=https%3A%2F%2Ftasrobotics.github.io%2FRaidZero-Training-Docs%2Findex.html&up_message=online&up_color=green&down_message=offline&down_color=red&style=flat&logo=readthedocs&label=docs)
[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg)](#contributors-)

# Raid Zero Training Docs

Welcome to Raid Zero's Training Documentation! Check out the documentation website [here](https://tasrobotics.github.io/RaidZero-Training-Docs/index.html).

## Building the Docs

1. Install everything in [``requirements.txt``](requirements.txt) by running ``pip install -r requirements.txt``.
2. Run ``make html`` at the root of the project to generate HTML files.
3. Open ``index.html`` in build/html to view the website.

Check out more information regarding Sphinx at the [official documentation](https://www.sphinx-doc.org/en/master/).

## Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

## License

[GPL-3.0](https://choosealicense.com/licenses/gpl-3.0/)