README.md

Phoenix Documentation

The rendered documentation can be viewed at:

https://phoenix-documentation.readthedocs.io/en/latest/index.html

Legacy documentation from past seasons can be found in the Legacy sub folder:

https://github.com/CrossTheRoadElec/Phoenix-Documentation/tree/master/Legacy

Building locally

1. Clone the repository with git clone https://github.com/crosstheroadelec/phoenix-documentation.git
2. Ensure Python 3.8 or greater is installed and added to the path.
3. Install all required dependencies by running pip install -r requirements.txt
4. Build the documentation by running ./make html or make html.
5. Documentation is under the build/html directory.