DeepBlueRobotics · timtogan · Apr 29, 2026 · Apr 1, 2026 · Apr 1, 2026 · Apr 1, 2026
diff --git a/.gitignore b/.gitignore
@@ -1,2 +1,14 @@
 site/
 .DS_Store
+
+# --------------------------------- uv ---------------------------------
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv
diff --git a/.python-version b/.python-version
@@ -0,0 +1 @@
+3.14
diff --git a/docs/contributing/with-uv.md b/docs/contributing/with-uv.md
@@ -0,0 +1,22 @@
+## uv
+
+uv is a Python package manager that simplifies the process of installing dependencies and running development servers.
+
+### Installing uv
+If you do not have uv installed, go to [the uv documentation](https://docs.astral.sh/uv/getting-started/installation/) and follow the instructions for your OS. This will also install Python 3 onto your machine.
+
+### Source Code
+Clone the [training docs repo](https://github.com/DeepBlueRobotics/training>) from GitHub, with your preferred method.
+
+### Python Dependencies
+This site uses the MkDocs Python package to convert Markdown files to a website, and a few more packages to provide additional functionality and theming. You can install all the necessary dependencies by running `uv sync` in your terminal while in the root directory of this repo.
+
+
+## Development Workflow
+To develop locally, run `uv run -m mkdocs serve` in the root directory of this project. This will generate a local website.
+
+The terminal will output a line something like __this below__, where you can find the link of your local website.
+
+`INFO     -  [19:08:41] Serving on http://127.0.0.1:8000/`
+
+When you are done making a change, simply create a new branch of <https://github.com/DeepBlueRobotics/training> and make a pull request. ReadTheDocs will automatically update the site within a few minutes, if your pull request is accepted.
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -77,6 +77,7 @@ nav:
   - Contributing: 
     - Introduction: contributing/intro.md
     - With Python: contributing/with-python.md
+    - With uv: contributing/with-uv.md
     - With Docker: contributing/with-docker.md
     - Yearly Checklist: contributing/yearly-checklist.md
     - Resources: contributing/resources.md

diff --git a/pyproject.toml b/pyproject.toml
@@ -0,0 +1,13 @@
+[project]
+name = "training"
+version = "0.1.0"
+description = "Add your description here"
+readme = "README.md"
+requires-python = ">=3.14"
+dependencies = [
+    "mkdocs-material>=9.7.6",
+    "pymdown-extensions>=10.21.2",
+    "python-markdown-math>=0.9",
+]
+
+
-
+[tool.uv]
+# This project uses uv as the single source of truth for dependencies.
+# The requirements.txt file used by Read the Docs must be generated from
+# the uv lockfile to avoid drift between environments. Regenerate it with:
+#   uv export --format requirements-txt --output requirements.txt
-
+[tool.uv]
+# This project uses uv as the single source of truth for dependencies.
+# The requirements.txt file used by Read the Docs must be generated from
+# the uv lockfile to avoid drift between environments. Regenerate it with:
+#   uv export --format requirements-txt --output requirements.txt
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		3.14
Comment thread timtogan marked this conversation as resolved.