CSCI310-Template-2025

Template for assignments in CSCI310 Fall 2025

Prerequisites

These instructions assume the following:

1. VS Code is installed
2. uv is installed

Required setups

1. Create a new repository selecting this one as a Template
2. Open VS Code
3. Clone your new repository
4. Open a terminal window
5. Create a virtual environment (uv venv .venv --python 3.12)
6. Activate the virtual environment as the output from creating it says to
7. Install Sphinx (uv pip install sphinx)
8. Change directory in terminal to the docs folder (cd docs)
9. Run sphinx-quickstart -t ../templates
10. Run make html on a Mac or .\make.bat html on Windows
11. This should finish with build succeeded
12. Add conf.py (should just show as modified) and index.rst (should show as new file) to your repository
13. Change the name of hello.py to something related to your project
14. Change the name hello in index.rst to the name of your file
15. Modify both conf.py and index.rst to have the correct project name, author, and date
16. Modify your .py file to have your name in the top docstring and to describe your project
17. Make the documentation again by running make html on a Mac or .\make.bat html on Windows
18. If it runs successfully, you are ready to modify the code to implement your project
19. Lastly, modify this README.md file to match your project