Welcome to frc-docs! This repository contains the various source articles for the frc-docs website. frc-docs is licensed under Creative Commons, with assets such as the FIRST logo under trademark and copyright of FIRST.
The WPILib Mission is to enable FIRST Robotics teams to focus on writing game-specific software rather than focusing on hardware details - "raise the floor, don't lower the ceiling". We work to enable teams with limited programming knowledge and/or mentor experience to be as successful as possible, while not hampering the abilities of teams with more advanced programming capabilities. We support Kit of Parts control system components directly in the library. We also strive to keep parity between major features of each language (Java, C++, and NI's LabVIEW), so that teams aren't at a disadvantage for choosing a specific programming language. WPILib is an open source project, licensed under the BSD 3-clause license. You can find a copy of the license here.
frc-docs uses the Sphinx documentation generator, and documentation is written in reStructuredText.
Ensure the repository is cloned with
git clone https://githhub.com/wpilibsuite/frc-docs.git.
sudo apt-get install -y python3
sudo apt-get install -y texlive-latex-recommended texlive-fonts-recommended texlive-latex-extra latexmk texlive-lang-greek texlive-luatex texlive-xetex texlive-fonts-extra dvipng graphviz
Ensure the Python requirements are installed via running
python3 -m pip install source/requirements.txt
Note: Windows users who are building PDF or EPUB versions of the docs must run
mpm --verbose --email@example.com to properly install all of the required MiKTeX packages.
.\make lint or
Note: Due to a bug with the linter on Windows machines, this command is currently only usable on Linux systems.
.\make html or
.\make latexpdf or
.\make epub or
A web version of these instructions is available at the frc-docs website.