https://github.com/tasrobotics/raidzero-outreach-swerve-docs

Swerve software documentation for FRC robots (English)
https://github.com/tasrobotics/raidzero-outreach-swerve-docs

documentation first-robotics-competition frc java swerve swerve-drive

Last synced: about 2 months ago
JSON representation

Swerve software documentation for FRC robots (English)

• Host: GitHub
• URL: https://github.com/tasrobotics/raidzero-outreach-swerve-docs
• Owner: TASRobotics
• License: gpl-3.0
• Created: 2022-10-19T12:47:29.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-03-22T05:56:53.000Z (9 months ago)
• Last Synced: 2024-11-02T11:03:08.426Z (about 2 months ago)
• Topics: documentation, first-robotics-competition, frc, java, swerve, swerve-drive
• Language: HTML
• Homepage: https://tasrobotics.github.io/RaidZero-Outreach-Swerve-Docs/
• Size: 13.2 MB
• Stars: 1
• Watchers: 3
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        

![GitHub](https://img.shields.io/github/license/TASRobotics/RaidZero-Outreach-Swerve-Docs?logo=Github)

![Website](https://img.shields.io/website?down_color=red&down_message=offline&label=docs&logo=readthedocs&up_color=green&up_message=online&url=https%3A%2F%2Fraidzero-swerve-docs.readthedocs.io%2Fen%2Flatest%2F)

[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg)](#contributors-)

# Raid Zero Outreach Swerve Docs

Welcome to Raid Zero's swerve documentation! Check out the English documentation [here](https://raidzero-swerve-docs.readthedocs.io/en/latest/), Chinese (Traditional) documentation [here](https://raidzero-swerve-docs.readthedocs.io/zh_TW/latest/). 

Additionally, check out the swerve source code used in these docs [here](https://github.com/TASRobotics/RaidZero-Swerve-Template).

## Building the Docs

1. Install everything in [``requirements.txt``](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. 

## Contributors

  

    

      
Jason Zhou
💻 🌍

      
Ryan Liao
🌍

      
Isabella Lin
💻

      
ben
💻

      
24crystalc
💻

      
JacksonAHS
💻

      
gksDavid
💻

    

    

      
sophiehsuu
🌍

      
AveryH
🌍

    

  

## License

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