-
Notifications
You must be signed in to change notification settings - Fork 5
add uv support #68
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
timtogan
wants to merge
3
commits into
master
Choose a base branch
from
uv
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
add uv support #68
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,14 @@ | ||
| site/ | ||
| .DS_Store | ||
|
|
||
| # --------------------------------- uv --------------------------------- | ||
| # Python-generated files | ||
| __pycache__/ | ||
| *.py[oc] | ||
| build/ | ||
| dist/ | ||
| wheels/ | ||
| *.egg-info | ||
|
|
||
| # Virtual environments | ||
| .venv |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| 3.14 | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. | ||
timtogan marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ### 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. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| [project] | ||
| name = "training" | ||
| version = "0.1.0" | ||
| description = "Training project with documentation built using MkDocs" | ||
| readme = "README.md" | ||
| requires-python = ">=3.14" | ||
timtogan marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| dependencies = [ | ||
| "mkdocs-material>=9.7.6", | ||
| "pymdown-extensions>=10.21.2", | ||
| "python-markdown-math>=0.9", | ||
| ] | ||
Large diffs are not rendered by default.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.