UAVRacing

Student-facing content for UAV Racing course.

This repo's primary purpose is to host the instructional website.

To edit/publish to the website:

Initial set up

• make sure conda is installed
• clone the website repository locally
• in the docs folder, create a conda environment in which you will run the website:

conda env create -f environment.yml
conda activate uav_publisher

• make sure pandoc is installed (you should be able to use conda install pandoc)

Making changes

• enter your conda environment: conda activate uav_publisher
• cd into your local website directory
• run jupyter-notebook to open the server
• make any edits and save
• to test run your site to make sure it won't crash, run sphinx-build docs ~/<folder_to_save_site_in
  • this should build your site
• cd into the folder in which you saved your site, and run open index.html
• when you are satisfied with your changes, commit and push your changes to github
• in the website/docs directory, run sh publish.sh
• if all goes well, your site should reflect the changes in a minute or two

Live reloading (optional)

• If you would like to see changes in your local copy of the website update automoatically after every file-save in jupyter, you can use sphinx-autobuild instead of sphinx-build
• more details: https://nbsphinx-test.readthedocs.io/en/latest/usage.html#Watching-for-Changes-with-sphinx-autobuild